Skip to content

Commit 0545d7e

Browse files
committed
more doc work, with some changes prompted by the doc
1 parent 31b4856 commit 0545d7e

27 files changed

+2173
-1288
lines changed

doc/modules/ROOT/nav.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,6 @@
1111
** xref:error_handling.adoc[Error Handling]
1212
** xref:custom_rtti.adoc[Custom RTTI]
1313
** xref:dynamic_loading.adoc[Dynamic Loading]
14-
* xref:reference:boost/openmethod.adoc[Reference (generated)]
15-
* xref:reference.adoc[Reference (manual)]
14+
* Reference
15+
** xref:macros.adoc[Macros]
16+
** xref:reference:boost/openmethod.adoc[boost::openmethod]

doc/modules/ROOT/pages/BOOST_OPENMETHOD_DEFAULT_REGISTRY.adoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1+
= xref:macros.adoc[Macro] BOOST_OPENMETHOD_DEFAULT_REGISTRY
12

2-
[#BOOST_OPENMETHOD_DEFAULT_REGISTRY]
3+
Default value for Registry
34

4-
## BOOST_OPENMETHOD_DEFAULT_REGISTRY
5+
== Synopsis
56

6-
### Description
7+
Defined in `<https://www.github.com/boostorg/openmethod/blob/develop/include/boost/openmethod/core.hpp#L27[boost/openmethod/core.hpp]>`
78

8-
The name of the default policy.
9+
```cpp
10+
#define BOOST_OPENMETHOD_DEFAULT_REGISTRY ::boost::openmethod::default_registry
11+
```
12+
13+
== Description
14+
15+
The name of the default registry.
916

1017
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` is the default value for the `Policy` template
1118
parameter of `method`, `use_classes`, and other constructs defined in

doc/modules/ROOT/pages/error_processing.adoc

Whitespace-only changes.

doc/modules/ROOT/pages/macros.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[#macros]
2+
= xref:macros.adoc[Macros]
3+
:mrdocs:
4+
5+
[cols=2]
6+
|===
7+
| Name
8+
| Description
9+
| xref:BOOST_OPENMETHOD.adoc[BOOST_OPENMETHOD]
10+
| Declare a method
11+
| xref:BOOST_OPENMETHOD_CLASSES.adoc[BOOST_OPENMETHOD_CLASSES]
12+
| registers classes
13+
| xref:BOOST_OPENMETHOD_DECLARE_OVERRIDER.adoc[BOOST_OPENMETHOD_DECLARE_OVERRIDER]
14+
| Declare a method overrider
15+
| xref:BOOST_OPENMETHOD_DEFAULT_REGISTRY.adoc[BOOST_OPENMETHOD_DEFAULT_REGISTRY]
16+
| Default registry
17+
| xref:BOOST_OPENMETHOD_DEFINE_OVERRIDER.adoc[BOOST_OPENMETHOD_DEFINE_OVERRIDER]
18+
| Define the body of a method overrider
19+
| xref:BOOST_OPENMETHOD_ID.adoc[BOOST_OPENMETHOD_ID]
20+
| Generate a method id
21+
| xref:BOOST_OPENMETHOD_INLINE_OVERRIDE.adoc[BOOST_OPENMETHOD_INLINE_OVERRIDE]
22+
| Add an overrider to a method as an inline function
23+
| xref:BOOST_OPENMETHOD_OVERRIDE.adoc[BOOST_OPENMETHOD_OVERRIDE]
24+
| Add an overrider to a method
25+
| xref:BOOST_OPENMETHOD_OVERRIDER.adoc[BOOST_OPENMETHOD_OVERRIDER]
26+
| Return the class template specialization containing an overrider
27+
| xref:BOOST_OPENMETHOD_OVERRIDERS.adoc[BOOST_OPENMETHOD_OVERRIDERS]
28+
| Return the class template containing the overriders for all the methods with a given name
29+
| xref:BOOST_OPENMETHOD_REGISTER.adoc[BOOST_OPENMETHOD_REGISTER]
30+
| Create a registrar object
31+
|===

doc/modules/ROOT/pages/reference.adoc

Lines changed: 0 additions & 176 deletions
This file was deleted.

doc/mrdocs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,24 @@ file-patterns:
1313
# Filters
1414
include-symbols:
1515
- 'boost::openmethod::**'
16+
implementation-defined:
17+
- 'boost::openmethod::detail'
1618
# see-below:
1719
# - 'boost::urls::format_arg'
1820
# implementation-defined:
1921
# - 'boost::openmethod::detail::**'
2022
exclude-symbols:
21-
- 'boost::openmethod::detail::**'
2223
- 'boost::openmethod::boost_openmethod_bases'
2324
- 'boost::openmethod::boost_openmethod_registry'
2425

2526
sort-members: false
27+
# sort-namespace-members-by: location
2628
extract-friends: false
27-
implementation-detail: impl
2829
inherit-base-members: never
2930

3031
# Metadata Extraction
3132
private-bases: false
33+
auto-function-metadata: false
3234

3335
# Generator
3436
generate: adoc

0 commit comments

Comments
 (0)