use Python version of Docca

This commit is contained in:
Dmitry Arkhipov
2025-05-02 13:55:56 +03:00
committed by Gennaro Prota
parent 9c5d69475d
commit 4c27826548
7 changed files with 92 additions and 35 deletions
+12 -15
View File
@@ -9,22 +9,21 @@
project static_string/doc ;
import boostbook ;
import type ;
import os ;
import-search /boost/docca ;
import docca ;
docca.reference reference.qbk
import docca ;
import path ;
import os ;
local include-prefix = [ path.root $(__file__:D) [ path.pwd ] ] ;
include-prefix = [ path.native $(include-prefix:D)/include ] ;
docca.pyreference reference.qbk
:
xsl/custom-overrides.xsl
[ glob-tree-ex ../include/boost/static_string : *.hpp *.ipp : detail impl ]
externals.hpp
:
<doxygen:param>PROJECT_NAME=StaticString
<doxygen:param>PROJECT_BRIEF="Static String Library"
<doxygen:param>ALIASES="esafe=\"@par Exception Safety\""
<doxygen:param>FILE_PATTERNS=
<doxygen:param>EXAMPLE_PATTERNS=
<doxygen:param>DISTRIBUTE_GROUP_DOC=YES
<doxygen:param>MACRO_EXPANSION=YES
<doxygen:param>EXPAND_ONLY_PREDEF=YES
@@ -41,19 +40,17 @@ docca.reference reference.qbk
<doxygen:param>EXTRACT_ALL=YES
<doxygen:param>EXTRACT_PRIVATE=YES
<doxygen:param>EXTRACT_LOCAL_CLASSES=NO
<doxygen:param>SHOW_INCLUDE_FILES=NO
<doxygen:param>INLINE_INFO=NO
<doxygen:param>SORT_MEMBER_DOCS=NO
<doxygen:param>SORT_MEMBERS_CTORS_1ST=YES
<doxygen:param>SHOW_USED_FILES=NO
<doxygen:param>SHOW_FILES=NO
<doxygen:param>SHOW_NAMESPACES=NO
<doxygen:param>CLASS_DIAGRAMS=NO
<doxygen:param>STRIP_FROM_PATH=$(include-prefix)
# <doxygen:param>ALLOW_UNICODE_NAMES=NO
# <doxygen:param>GROUP_NESTED_COMPOUNDS=NO
# <doxygen:param>HIDE_COMPOUND_REFERENCE=NO
# <doxygen:param>WARN_AS_ERROR=NO
<docca:config>config.json
;
#-------------------------------------------------------------------------------
+12
View File
@@ -0,0 +1,12 @@
{
"include_private": false,
"legacy_behavior": false,
"external_marker": "!EXTERNAL!",
"link_prefix": "static_string.ref.",
"default_namespace": "boost::static_strings",
"allowed_prefixes": ["boost::static_strings::", "std::"],
"convenience_header": "boost/static_string.hpp",
"replace_strings": {
"__see_below__": "``['see-below]``"
}
}
+64
View File
@@ -0,0 +1,64 @@
#pragma once
namespace boost {
/// !EXTERNAL!
///
/// @see https://www.boost.org/doc/libs/release/libs/utility/doc/html/utility/utilities/string_view.html
template <class T, class Traits>
struct basic_string_view {};
} // namespace boost
namespace std {
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/iterator/reverse_iterator
template <class T>
struct reverse_iterator {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/size_t
struct size_t {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/integer
struct uint64_t {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/integer
struct int64_t {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/nullptr_t
struct nullptr_t {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/ptrdiff_t
struct ptrdiff_t {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/utility/initializer_list
template <class T>
struct initializer_list {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/io/basic_ostream
template <class T, class Traits>
struct basic_ostream {};
/// !EXTERNAL!
///
/// @see https://en.cppreference.com/w/cpp/types/numeric_limits
template <class T>
struct numeric_limits {};
} // namespace std
-11
View File
@@ -1,11 +0,0 @@
<xsl:stylesheet version="3.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
exclude-result-prefixes="xs"
expand-text="yes">
<xsl:variable name="doc-ref" select="'static_string.ref'"/>
<xsl:variable name="doc-ns" select="'boost::static_strings'"/>
<xsl:variable name="include-private-members" select="false()"/>
</xsl:stylesheet>