diff --git a/doc/build_antora.sh b/doc/build_antora.sh index cf3b6e5..21871e1 100755 --- a/doc/build_antora.sh +++ b/doc/build_antora.sh @@ -1,3 +1,5 @@ +#!/bin/bash + # # Copyright (c) 2023 Alan de Freitas (alandefreitas@gmail.com) # @@ -29,7 +31,7 @@ npx antora --clean --fetch "$PLAYBOOK" --stacktrace --log-level all echo "Fixing links to non-mrdocs URIs..." for f in $(find build/site -name '*.html'); do - perl -i -pe 's{[(.*?)]\(([^)]+)\)}{$1}g' "$f" + perl -i -pe 's{{{(.*?)}}}{$1}g' "$f" done echo "Done" diff --git a/doc/gentags.sh b/doc/gentags.sh new file mode 100755 index 0000000..1c1893b --- /dev/null +++ b/doc/gentags.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +mrdocs && cp reference-output/reference.tag.xml tagfiles/boost-openmethod-doxygen.tag.xml diff --git a/doc/tagfiles/boost-openmethod-doxygen.tag.xml b/doc/tagfiles/boost-openmethod-doxygen.tag.xml index 3738e8b..ed51403 100644 --- a/doc/tagfiles/boost-openmethod-doxygen.tag.xml +++ b/doc/tagfiles/boost-openmethod-doxygen.tag.xml @@ -27,7 +27,6 @@ boost::openmethod::n2216 boost::openmethod::no_overrider boost::openmethod::not_initialized - boost::openmethod::odr_check boost::openmethod::odr_violation boost::openmethod::openmethod_error boost::openmethod::registry @@ -589,17 +588,6 @@ (Stream& os) - - boost::openmethod::odr_check - boost/openmethod/odr_check.adoc - - void - odr_check - boost/openmethod/odr_check/2constructor.adoc - - () - - boost::openmethod::odr_violation boost/openmethod/odr_violation.adoc @@ -617,18 +605,18 @@ boost::openmethod::registry - boost/openmethod/registry-07.adoc + boost/openmethod/registry-07c.adoc void require_initialized - boost/openmethod/registry-07/require_initialized.adoc + boost/openmethod/registry-07c/require_initialized.adoc () void finalize - boost/openmethod/registry-07/finalize.adoc + boost/openmethod/registry-07c/finalize.adoc (...Options opts) diff --git a/include/boost/openmethod/core.hpp b/include/boost/openmethod/core.hpp index 426b5ba..478d07f 100644 --- a/include/boost/openmethod/core.hpp +++ b/include/boost/openmethod/core.hpp @@ -633,7 +633,7 @@ inline auto final_virtual_ptr(Arg&& obj) { //! the other way around. //! //! The default value for `Registry` can be customized by defining the -//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html) +//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}} //! preprocessor symbol. //! //! The default value for `Registry` can be customized by defining the diff --git a/include/boost/openmethod/default_registry.hpp b/include/boost/openmethod/default_registry.hpp index a943c71..fd9314c 100644 --- a/include/boost/openmethod/default_registry.hpp +++ b/include/boost/openmethod/default_registry.hpp @@ -18,7 +18,7 @@ namespace boost::openmethod { //! Default registry. //! //! `default_registry` is a predefined @ref registry, and the default value of -//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html). +//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}}. //! It contains the following policies: //! @li @ref policies::std_rtti: Use standard RTTI. //! @li @ref policies::fast_perfect_hash: Use a fast perfect hash function to @@ -28,7 +28,7 @@ namespace boost::openmethod { //! @li @ref policies::stderr_output: Write messages to `stderr`. //! //! If -//! [BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS](../BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS.html) +//! {{BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS}} //! is defined, `default_registry` also includes the @ref runtime_checks policy. //! //! @note Use `BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS` with caution, as diff --git a/include/boost/openmethod/initialize.hpp b/include/boost/openmethod/initialize.hpp index 598a0ef..014d264 100644 --- a/include/boost/openmethod/initialize.hpp +++ b/include/boost/openmethod/initialize.hpp @@ -1507,7 +1507,7 @@ void registry::compiler::print( //! Initialize the @ref registry passed as an explicit function template //! argument, or @ref default_registry if the registry is not specified. The //! default can be changed by defining -//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html). +//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}}. //! Option objects can be passed to change the behavior of the function. //! Currently two options exist: //! @li @ref trace Enable tracing of the initialization process. diff --git a/include/boost/openmethod/inplace_vptr.hpp b/include/boost/openmethod/inplace_vptr.hpp index aba74a9..0ddf534 100644 --- a/include/boost/openmethod/inplace_vptr.hpp +++ b/include/boost/openmethod/inplace_vptr.hpp @@ -1,5 +1,5 @@ -#ifndef BOOST_OPENMETHOD_inplace_vptr_HPP -#define BOOST_OPENMETHOD_inplace_vptr_HPP +#ifndef BOOST_OPENMETHOD_INPLACE_VPTR_HPP +#define BOOST_OPENMETHOD_INPLACE_VPTR_HPP #include @@ -68,7 +68,7 @@ class inplace_vptr_base_tag {}; //! //! `inplace_vptr_base` registers the class in `Registry`. It is not necessary //! to register the class with @ref use_class or -//! [BOOST_OPENMETHOD_REGISTER](../BOOST_OPENMETHOD_REGISTER.html) +//! {{BOOST_OPENMETHOD_REGISTER}} //! //! The v-table pointer is obtained directly from the `Registry`\'s @ref //! static_vptr variable. No hashing is involved. If all the classes in @@ -81,7 +81,7 @@ class inplace_vptr_base_tag {}; //! to @ref initialize. //! //! The default value of `Registry` can be changed by defining -//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html) +//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}} //! //! @tparam Class The class in which to embed the v-table pointer. //! @tparam Registry The @ref registry in which `Class` and its derived classes @@ -167,7 +167,7 @@ class inplace_vptr_base : protected detail::inplace_vptr_base_tag { //! //! `inplace_vptr_derived` registers the class and its bases in `Registry`. It //! is not necessary to register them with @ref use_class or -//! [BOOST_OPENMETHOD_REGISTER](../BOOST_OPENMETHOD_REGISTER.html) +//! {{BOOST_OPENMETHOD_REGISTER}} //! //! The v-table pointer is obtained directly from the `Registry`\'s @ref //! static_vptr variable. No hashing is involved. If all the classes in diff --git a/include/boost/openmethod/preamble.hpp b/include/boost/openmethod/preamble.hpp index 4867a3f..a4014b0 100644 --- a/include/boost/openmethod/preamble.hpp +++ b/include/boost/openmethod/preamble.hpp @@ -79,7 +79,7 @@ struct openmethod_error {}; //! //! This error is raised if the definition of @ref default_registry is //! inconsistent across translation units, due to misuse of -//! [BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS](../BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS.html). +//! {{BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS}}. struct odr_violation : openmethod_error { //! Write a description of the error to a stream. //! @tparam Registry The registry containing this policy.