mirror of
https://github.com/boostorg/url.git
synced 2026-01-26 19:12:14 +00:00
81 lines
2.6 KiB
YAML
81 lines
2.6 KiB
YAML
# Input
|
|
source-root: ..
|
|
# Directories that contain documented source files
|
|
input:
|
|
- ../include
|
|
# Patterns to filter out the source-files in the directories
|
|
file-patterns:
|
|
- '*.hpp'
|
|
exclude:
|
|
- '../include/boost/url/impl'
|
|
- '../include/boost/url/grammar/impl'
|
|
- '../include/boost/url/rfc/impl'
|
|
|
|
# Filters
|
|
include-symbols:
|
|
- 'boost::urls::**'
|
|
see-below:
|
|
- 'boost::urls::format_arg'
|
|
- 'boost::urls::named_arg'
|
|
- 'boost::urls::see_below'
|
|
- 'boost::urls::*_t'
|
|
- 'boost::urls::grammar::see_below'
|
|
- 'boost::urls::string_token::see_below'
|
|
- 'boost::urls::decode_view::iterator'
|
|
- 'boost::urls::params_base::iterator'
|
|
- 'boost::urls::params_encoded_base::iterator'
|
|
- 'boost::urls::segments_base::iterator'
|
|
- 'boost::urls::segments_encoded_base::iterator'
|
|
implementation-defined:
|
|
- 'boost::urls::detail'
|
|
- 'boost::urls::**::detail'
|
|
- 'boost::urls::*_unsafe'
|
|
- 'boost::urls::make_error_code'
|
|
- 'boost::urls::make_void'
|
|
- 'boost::urls::implementation_defined'
|
|
- 'boost::urls::grammar::implementation_defined'
|
|
- 'boost::urls::string_token::implementation_defined'
|
|
- 'boost::urls::grammar::*_t'
|
|
- 'boost::urls::grammar::make_error_*'
|
|
- 'boost::urls::grammar::operator_*'
|
|
- 'boost::urls::string_token::*_t'
|
|
exclude-symbols:
|
|
- 'boost::urls::void_t'
|
|
# any_rule was previously excluded by the detail path rule
|
|
- 'boost::urls::any_rule'
|
|
|
|
# Metadata Extraction
|
|
private-bases: false
|
|
|
|
# Generator
|
|
generator: adoc
|
|
base-url: https://www.github.com/boostorg/url/blob/develop/ # boost/url/url_view.hpp
|
|
|
|
# Style
|
|
verbose: true
|
|
multipage: true
|
|
|
|
# The target for MrDocs simply includes all symbols defined in all
|
|
# headers with the appropriate compilation options.
|
|
# Nothing else should be included in the MrDocs configuration or
|
|
# would be useful to MrDocs.
|
|
#
|
|
# This single source file not only includes all symbols (the source
|
|
# files do not collectively include all headers) but also makes MrDocs
|
|
# run much faster than relying on the entire library.
|
|
#
|
|
# The time to extract the declarations went from ~8m6s to ~3s in our
|
|
# experiments: a 162x speedup while including all symbols!
|
|
#
|
|
# In practice, this special target is simply emulating the
|
|
# default behavior of the standardese tool with MrDocs, which
|
|
# requires the user to clearly specify the targets via the
|
|
# compilation database.
|
|
#
|
|
# The BOOST_URL_MRDOCS_BUILD=ON is the only option we usually need
|
|
# here.
|
|
# The other options are set just to ensure other targets are
|
|
# ignored even if these options are set as ON in the cache.
|
|
#
|
|
cmake: '-D BOOST_URL_MRDOCS_BUILD=ON -D CMAKE_CXX_STANDARD=20 -D BOOST_URL_BUILD_FUZZERS=OFF -D BOOST_URL_BUILD_EXAMPLES=OFF -D BOOST_URL_BUILD_TESTS=OFF -D BUILD_TESTING=OFF'
|