Skip to content

Commit 73fdace

Browse files
committed
wip
1 parent 3303969 commit 73fdace

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

doc/modules/ROOT/pages/ref_headers.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ pointers, and mechanisms to implement them. Does not define any public macros
3232
apart from `BOOST_OPENMETHOD_DEFAULT_REGISTRY`, if it is not defined already.
3333

3434
[#macros]
35-
### <boost/openmethod/macros.hpp>
35+
### link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>]
3636

3737
Defines the public macros of the library, such as `BOOST_OPENMETHOD`,
3838
`BOOST_OPENMETHOD_CLASSES`, etc.
@@ -41,26 +41,26 @@ There is little point in including this header directly, as this has the same
4141
effect as including `boost/openmethod.hpp`, which is shorter.
4242

4343
[#openmethod]
44-
### <boost/openmethod.hpp>
44+
### link:{{BASE_URL}}/include/boost/openmethod.hpp[<boost/openmethod.hpp>]
4545

4646
Includes `core.hpp` and `macros.hpp`.
4747

4848
[#initialize]
49-
### <boost/initialize.hpp>
49+
### link:{{BASE_URL}}/include/boost/initialize.hpp[<boost/initialize.hpp>]
5050

5151
Provides the cpp:initialize[] and cpp:finalize[] functions. This header is
5252
typically included in the translation unit containing `main`. Translation units
5353
that dynamically load or unload shared libraries may also need to call those
5454
functions.
5555

5656
[#std_shared_ptr]
57-
### <boost/openmethod/interop/std_shared_ptr.hpp>
57+
### link:{{BASE_URL}}/include/boost/openmethod/interop/std_shared_ptr.hpp[<boost/openmethod/interop/std_shared_ptr.hpp>]
5858

5959
Provides a `virtual_traits` specialization that make it possible to use a
6060
`std::shared_ptr` in place of a raw pointer or reference in virtual parameters.
6161

6262
[#std_unique_ptr]
63-
### <boost/openmethod/interop/std_unique_ptr.hpp>
63+
### link:{{BASE_URL}}/include/boost/openmethod/interop/std_unique_ptr.hpp[<boost/openmethod/interop/std_unique_ptr.hpp>]
6464

6565
Provides a `virtual_traits` specialization that make it possible to use a
6666
`std::unique_ptr` in place of a raw pointer or reference in virtual parameters.
@@ -73,52 +73,52 @@ The following headers can be included before `core.hpp` to define custom
7373
registries and policies, and override the default registry by defining
7474
xref:BOOST_OPENMETHOD_DEFAULT_REGISTRY.adoc[`BOOST_OPENMETHOD_DEFAULT_REGISTRY`].
7575

76-
### <boost/openmethod/preamble.hpp>
76+
### link:{{BASE_URL}}/include/boost/openmethod/preamble.hpp[<boost/openmethod/preamble.hpp>]
7777

7878
Defines `registry` and stock policy categories. Also defines all types and
7979
functions necessary for the definition of `registry`.
8080

81-
### <boost/openmethod/policies/std_rtti.hpp>
81+
### link:{{BASE_URL}}/include/boost/openmethod/policies/std_rtti.hpp[<boost/openmethod/policies/std_rtti.hpp>]
8282

8383
Provides an implementation of the `rtti` policy using standard RTTI.
8484

85-
### <boost/openmethod/policies/fast_perfect_hash.hpp>
85+
### link:{{BASE_URL}}/include/boost/openmethod/policies/fast_perfect_hash.hpp[<boost/openmethod/policies/fast_perfect_hash.hpp>]
8686

8787
Provides an implementation of the `hash` policy using a fast perfect hash
8888
function.
8989

90-
### <boost/openmethod/policies/vptr_vector.hpp>
90+
### link:{{BASE_URL}}/include/boost/openmethod/policies/vptr_vector.hpp[<boost/openmethod/policies/vptr_vector.hpp>]
9191

9292
Provides an implementation of the `vptr` policy that stores the v-table pointers
9393
in a `std::vector` indexed by type ids, possibly hashed.
9494

95-
### <boost/openmethod/policies/default_error_handler.hpp>
95+
### link:{{BASE_URL}}/include/boost/openmethod/policies/default_error_handler.hpp[<boost/openmethod/policies/default_error_handler.hpp>]
9696

9797
Provides an implementation of the `error_handler` policy that calls a
9898
`std::function<void(openmethod_error)>` when an error is encountered, and before
9999
the library aborts the program.
100100

101-
### <boost/openmethod/policies/stderr_output.hpp>
101+
### link:{{BASE_URL}}/include/boost/openmethod/policies/stderr_output.hpp[<boost/openmethod/policies/stderr_output.hpp>]
102102

103103
Provides an implementation of the `output` policy that writes diagnostics to
104104
the C standard error stream (not using iostreams).
105105

106-
### <boost/openmethod/default_registry.hpp>
106+
### link:{{BASE_URL}}/include/boost/openmethod/default_registry.hpp[<boost/openmethod/default_registry.hpp>]
107107

108108
Defines the default registry, which contains all the stock policies listed
109109
above. Includes all the headers listed in this section so far.
110110

111-
### <boost/openmethod/policies/static_rtti.hpp>
111+
### link:{{BASE_URL}}/include/boost/openmethod/policies/static_rtti.hpp[<boost/openmethod/policies/static_rtti.hpp>]
112112

113113
Provides a minimal implementation of the `rtti` policy that does not depend on
114114
standard RTTI.
115115

116-
### <boost/openmethod/policies/throw_error_handler.hpp>
116+
### link:{{BASE_URL}}/include/boost/openmethod/policies/throw_error_handler.hpp[<boost/openmethod/policies/throw_error_handler.hpp>]
117117

118118
Provides an implementation of the `error_handler` policy that throws errors as
119119
exceptions.
120120

121-
### <boost/openmethod/policies/vptr_map.hpp>
121+
### link:{{BASE_URL}}/include/boost/openmethod/policies/vptr_map.hpp[<boost/openmethod/policies/vptr_map.hpp>]
122122

123123
Provides an implementation of the `vptr` policy that stores the v-table pointers
124124
in a map (by default a `std::map`) indexed by type ids.

0 commit comments

Comments
 (0)