Skip to content

Commit 00abd91

Browse files
committed
fix adoc-mrdocs xrefs
1 parent 9ecf915 commit 00abd91

File tree

8 files changed

+19
-26
lines changed

8 files changed

+19
-26
lines changed

doc/build_antora.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#!/bin/bash
2+
13
#
24
# Copyright (c) 2023 Alan de Freitas ([email protected])
35
#
@@ -29,7 +31,7 @@ npx antora --clean --fetch "$PLAYBOOK" --stacktrace --log-level all
2931
echo "Fixing links to non-mrdocs URIs..."
3032

3133
for f in $(find build/site -name '*.html'); do
32-
perl -i -pe 's{&lsqb;(.*?)&rsqb;\(([^)]+)\)}{<a href="../../$2">$1</a>}g' "$f"
34+
perl -i -pe 's{&lcub;&lcub;(.*?)&rcub;&rcub;}{<a href="../../../$1.html">$1</a>}g' "$f"
3335
done
3436

3537
echo "Done"

doc/gentags.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
mrdocs && cp reference-output/reference.tag.xml tagfiles/boost-openmethod-doxygen.tag.xml

doc/tagfiles/boost-openmethod-doxygen.tag.xml

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
<class kind="class">boost::openmethod::n2216</class>
2828
<class kind="class">boost::openmethod::no_overrider</class>
2929
<class kind="class">boost::openmethod::not_initialized</class>
30-
<class kind="class">boost::openmethod::odr_check</class>
3130
<class kind="class">boost::openmethod::odr_violation</class>
3231
<class kind="class">boost::openmethod::openmethod_error</class>
3332
<class kind="class">boost::openmethod::registry</class>
@@ -589,17 +588,6 @@
589588
<arglist>(Stream&amp; os)</arglist>
590589
</member>
591590
</compound>
592-
<compound kind="class">
593-
<name>boost::openmethod::odr_check</name>
594-
<filename>boost/openmethod/odr_check.adoc</filename>
595-
<member kind="function">
596-
<type>void</type>
597-
<name>odr_check</name>
598-
<anchorfile>boost/openmethod/odr_check/2constructor.adoc</anchorfile>
599-
<anchor/>
600-
<arglist>()</arglist>
601-
</member>
602-
</compound>
603591
<compound kind="class">
604592
<name>boost::openmethod::odr_violation</name>
605593
<filename>boost/openmethod/odr_violation.adoc</filename>
@@ -617,18 +605,18 @@
617605
</compound>
618606
<compound kind="class">
619607
<name>boost::openmethod::registry</name>
620-
<filename>boost/openmethod/registry-07.adoc</filename>
608+
<filename>boost/openmethod/registry-07c.adoc</filename>
621609
<member kind="function">
622610
<type>void</type>
623611
<name>require_initialized</name>
624-
<anchorfile>boost/openmethod/registry-07/require_initialized.adoc</anchorfile>
612+
<anchorfile>boost/openmethod/registry-07c/require_initialized.adoc</anchorfile>
625613
<anchor/>
626614
<arglist>()</arglist>
627615
</member>
628616
<member kind="function">
629617
<type>void</type>
630618
<name>finalize</name>
631-
<anchorfile>boost/openmethod/registry-07/finalize.adoc</anchorfile>
619+
<anchorfile>boost/openmethod/registry-07c/finalize.adoc</anchorfile>
632620
<anchor/>
633621
<arglist>(...Options opts)</arglist>
634622
</member>

include/boost/openmethod/core.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -633,7 +633,7 @@ inline auto final_virtual_ptr(Arg&& obj) {
633633
//! the other way around.
634634
//!
635635
//! The default value for `Registry` can be customized by defining the
636-
//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html)
636+
//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}}
637637
//! preprocessor symbol.
638638
//!
639639
//! The default value for `Registry` can be customized by defining the

include/boost/openmethod/default_registry.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace boost::openmethod {
1818
//! Default registry.
1919
//!
2020
//! `default_registry` is a predefined @ref registry, and the default value of
21-
//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html).
21+
//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}}.
2222
//! It contains the following policies:
2323
//! @li @ref policies::std_rtti: Use standard RTTI.
2424
//! @li @ref policies::fast_perfect_hash: Use a fast perfect hash function to
@@ -28,7 +28,7 @@ namespace boost::openmethod {
2828
//! @li @ref policies::stderr_output: Write messages to `stderr`.
2929
//!
3030
//! If
31-
//! [BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS](../BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS.html)
31+
//! {{BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS}}
3232
//! is defined, `default_registry` also includes the @ref runtime_checks policy.
3333
//!
3434
//! @note Use `BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS` with caution, as

include/boost/openmethod/initialize.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1507,7 +1507,7 @@ void registry<Policies...>::compiler<Options...>::print(
15071507
//! Initialize the @ref registry passed as an explicit function template
15081508
//! argument, or @ref default_registry if the registry is not specified. The
15091509
//! default can be changed by defining
1510-
//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html).
1510+
//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}}.
15111511
//! Option objects can be passed to change the behavior of the function.
15121512
//! Currently two options exist:
15131513
//! @li @ref trace Enable tracing of the initialization process.

include/boost/openmethod/inplace_vptr.hpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
#ifndef BOOST_OPENMETHOD_inplace_vptr_HPP
2-
#define BOOST_OPENMETHOD_inplace_vptr_HPP
1+
#ifndef BOOST_OPENMETHOD_INPLACE_VPTR_HPP
2+
#define BOOST_OPENMETHOD_INPLACE_VPTR_HPP
33

44
#include <boost/openmethod/core.hpp>
55

@@ -68,7 +68,7 @@ class inplace_vptr_base_tag {};
6868
//!
6969
//! `inplace_vptr_base` registers the class in `Registry`. It is not necessary
7070
//! to register the class with @ref use_class or
71-
//! [BOOST_OPENMETHOD_REGISTER](../BOOST_OPENMETHOD_REGISTER.html)
71+
//! {{BOOST_OPENMETHOD_REGISTER}}
7272
//!
7373
//! The v-table pointer is obtained directly from the `Registry`\'s @ref
7474
//! static_vptr variable. No hashing is involved. If all the classes in
@@ -81,7 +81,7 @@ class inplace_vptr_base_tag {};
8181
//! to @ref initialize.
8282
//!
8383
//! The default value of `Registry` can be changed by defining
84-
//! [BOOST_OPENMETHOD_DEFAULT_REGISTRY](../BOOST_OPENMETHOD_DEFAULT_REGISTRY.html)
84+
//! {{BOOST_OPENMETHOD_DEFAULT_REGISTRY}}
8585
//!
8686
//! @tparam Class The class in which to embed the v-table pointer.
8787
//! @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 {
167167
//!
168168
//! `inplace_vptr_derived` registers the class and its bases in `Registry`. It
169169
//! is not necessary to register them with @ref use_class or
170-
//! [BOOST_OPENMETHOD_REGISTER](../BOOST_OPENMETHOD_REGISTER.html)
170+
//! {{BOOST_OPENMETHOD_REGISTER}}
171171
//!
172172
//! The v-table pointer is obtained directly from the `Registry`\'s @ref
173173
//! static_vptr variable. No hashing is involved. If all the classes in

include/boost/openmethod/preamble.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ struct openmethod_error {};
7979
//!
8080
//! This error is raised if the definition of @ref default_registry is
8181
//! inconsistent across translation units, due to misuse of
82-
//! [BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS](../BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS.html).
82+
//! {{BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS}}.
8383
struct odr_violation : openmethod_error {
8484
//! Write a description of the error to a stream.
8585
//! @tparam Registry The registry containing this policy.

0 commit comments

Comments
 (0)