fix adoc-mrdocs xrefs

This commit is contained in:
Jean-Louis Leroy
2025-10-21 13:04:05 -04:00
parent 9ecf9158f9
commit 00abd9176b
8 changed files with 19 additions and 26 deletions

View File

@@ -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{&lsqb;(.*?)&rsqb;\(([^)]+)\)}{<a href="../../$2">$1</a>}g' "$f"
perl -i -pe 's{&lcub;&lcub;(.*?)&rcub;&rcub;}{<a href="../../../$1.html">$1</a>}g' "$f"
done
echo "Done"

3
doc/gentags.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/bin/bash
mrdocs && cp reference-output/reference.tag.xml tagfiles/boost-openmethod-doxygen.tag.xml

View File

@@ -27,7 +27,6 @@
<class kind="class">boost::openmethod::n2216</class>
<class kind="class">boost::openmethod::no_overrider</class>
<class kind="class">boost::openmethod::not_initialized</class>
<class kind="class">boost::openmethod::odr_check</class>
<class kind="class">boost::openmethod::odr_violation</class>
<class kind="class">boost::openmethod::openmethod_error</class>
<class kind="class">boost::openmethod::registry</class>
@@ -589,17 +588,6 @@
<arglist>(Stream&amp; os)</arglist>
</member>
</compound>
<compound kind="class">
<name>boost::openmethod::odr_check</name>
<filename>boost/openmethod/odr_check.adoc</filename>
<member kind="function">
<type>void</type>
<name>odr_check</name>
<anchorfile>boost/openmethod/odr_check/2constructor.adoc</anchorfile>
<anchor/>
<arglist>()</arglist>
</member>
</compound>
<compound kind="class">
<name>boost::openmethod::odr_violation</name>
<filename>boost/openmethod/odr_violation.adoc</filename>
@@ -617,18 +605,18 @@
</compound>
<compound kind="class">
<name>boost::openmethod::registry</name>
<filename>boost/openmethod/registry-07.adoc</filename>
<filename>boost/openmethod/registry-07c.adoc</filename>
<member kind="function">
<type>void</type>
<name>require_initialized</name>
<anchorfile>boost/openmethod/registry-07/require_initialized.adoc</anchorfile>
<anchorfile>boost/openmethod/registry-07c/require_initialized.adoc</anchorfile>
<anchor/>
<arglist>()</arglist>
</member>
<member kind="function">
<type>void</type>
<name>finalize</name>
<anchorfile>boost/openmethod/registry-07/finalize.adoc</anchorfile>
<anchorfile>boost/openmethod/registry-07c/finalize.adoc</anchorfile>
<anchor/>
<arglist>(...Options opts)</arglist>
</member>

View File

@@ -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

View File

@@ -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

View File

@@ -1507,7 +1507,7 @@ void registry<Policies...>::compiler<Options...>::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.

View File

@@ -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 <boost/openmethod/core.hpp>
@@ -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

View File

@@ -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.