Skip to content

Commit 48e8554

Browse files
jll63jll63
committed
improve documentation
1 parent 8933eb3 commit 48e8554

36 files changed

+189
-250
lines changed

‎doc/introduction.adoc‎

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

‎doc/modules/ROOT/nav.adoc‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
* xref:introduction.adoc[Introduction]
2-
* xref:basics.adoc[Open-Methods 101]
3-
* xref:performance.adoc[Performance]
4-
* xref:smart_pointers.adoc[Smart Pointers]
5-
* xref:headers.adoc[Headers]
6-
* xref:namespaces.adoc[Namespaces]
7-
* xref:friendship.adoc[Friendship]
8-
* xref:multiple_dispatch.adoc[Multiple Dispatch]
1+
* xref:motivation.adoc[Motivation]
2+
* Basic Features
3+
** xref:basics.adoc[Methods and Overriders]
4+
** xref:performance.adoc[Performance]
5+
** xref:smart_pointers.adoc[Smart Pointers]
6+
** xref:headers.adoc[Header and Implementation Files]
7+
** xref:namespaces.adoc[Namespaces]
8+
** xref:friends.adoc[Friends]
9+
** xref:multiple_dispatch.adoc[Multiple Dispatch]
910
* Advanced Features
1011
** xref:core_api.adoc[Core API]
1112
** xref:registries_and_policies.adoc[Registries and Policies]

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11

2-
= BOOST_OPENMETHOD
2+
# BOOST_OPENMETHOD
33

4-
### Synopsis
4+
## Synopsis
55

66
Defined in link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>].
77

88
```c++
99
BOOST_OPENMETHOD(ID, (PARAMETERS...), RETURN_TYPE [, REGISTRY]);
1010
```
1111

12-
### Description
12+
## Description
1313

1414
Declares a method, called `ID`, with the given `PARAMETERS` and `RETURN_TYPE`,
1515
and adds it to `REGISTRY`.
@@ -58,7 +58,7 @@ NOTE: The default value for `REGISTRY` is the value of
5858
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` at the point `<boost/openmethod/core.hpp>` is
5959
included. Changing the value of this symbol has no effect after that point.
6060

61-
### Implementation Notes
61+
## Implementation Notes
6262

6363
The macro creates several additional constructs:
6464

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_CLASSES.adoc‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
1+
# BOOST_OPENMETHOD_CLASSES
12

2-
[#BOOST_OPENMETHOD_CLASSES]
3-
4-
## BOOST_OPENMETHOD_CLASSES
5-
6-
### Synopsis
3+
## Synopsis
74

85
Defined in link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>].
96

107
```c++
118
BOOST_OPENMETHOD_CLASSES(CLASSES...[, REGISTRY]);
129
```
1310

14-
### Description
11+
## Description
1512

1613
Registers `CLASSES` in REGISTRY.
1714

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_DECLARE_OVERRIDER.adoc‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1+
# BOOST_OPENMETHOD_DECLARE_OVERRIDER
12

2-
## BOOST_OPENMETHOD_DECLARE_OVERRIDER
3-
4-
### Synopsis
3+
## Synopsis
54

65
Defined in link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>].
76

87
```c++
98
#define BOOST_OPENMETHOD_DECLARE_OVERRIDER(NAME, (PARAMETERS...), RETURN_TYPE)
109
```
1110

12-
### Description
11+
## Description
1312

1413
Declares an overrider for a method, but does not start its definition. This
1514
macro can be used in header files.
@@ -33,7 +32,7 @@ Each `virtual_<T>` in the method's parameter list must have a corresponding `U`
3332
parameter in the same position in the overrider's parameter list, such that `U`
3433
is the same as `T`, or has `T` as an accessible unambiguous base.
3534

36-
### Implementation Notes
35+
## Implementation Notes
3736

3837
The macro creates additional entities in the current scope.
3938

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_DEFAULT_REGISTRY.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= xref:macros.adoc[Macro]&nbsp;BOOST_OPENMETHOD_DEFAULT_REGISTRY
1+
# BOOST_OPENMETHOD_DEFAULT_REGISTRY
22

33
Default value for Registry
44

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_DEFINE_OVERRIDER.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11

2-
## BOOST_OPENMETHOD_DEFINE_OVERRIDER
2+
# BOOST_OPENMETHOD_DEFINE_OVERRIDER
33

4-
### Synopsis
4+
## Synopsis
55

66
Defined in link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>].
77

88
```c++
99
#define BOOST_OPENMETHOD_DEFINE_OVERRIDER(ID, (PARAMETERS...), RETURN_TYPE)
1010
```
1111

12-
### Description
12+
## Description
1313

1414
Defines the body of an overrider declared with
1515
xref:BOOST_OPENMETHOD_DECLARE_OVERRIDER.adoc[BOOST_OPENMETHOD_DECLARE_OVERRIDER].

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

2-
## BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS
2+
# BOOST_OPENMETHOD_ENABLE_RUNTIME_CHECKS
33

44
Enables runtime checks in cpp:default_registry[].
55

6-
### Synopsis
6+
## Synopsis
77

88
May be defined by a program before including
99
`<boost/openmethod/default_registry.hpp>` to enable runtime checks.
1010

11-
### Description
11+
## Description
1212

1313
See cpp:default_registry[] for details.

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_ID.adoc‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11

2-
[#BOOST_OPENMETHOD_ID]
2+
# BOOST_OPENMETHOD_ID
33

4-
## BOOST_OPENMETHOD_ID
5-
6-
### Synopsis
4+
## Synopsis
75

86
Defined in link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>].
97

108
```c++
119
#define BOOST_OPENMETHOD_ID(ID) /* unspecified */
1210
```
1311
14-
### Description
12+
## Description
1513
1614
Generates a long, obfuscated name from a short name. All the other names
1715
generated by macros are based on this name.

‎doc/modules/ROOT/pages/BOOST_OPENMETHOD_INLINE_OVERRIDE.adoc‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1+
# BOOST_OPENMETHOD_INLINE_OVERRIDE
12

2-
[#BOOST_OPENMETHOD_INLINE_OVERRIDE]
3-
4-
## BOOST_OPENMETHOD_INLINE_OVERRIDE
5-
6-
### Synopsis
3+
## Synopsis
74

85
Defined in link:{{BASE_URL}}/include/boost/openmethod/macros.hpp[<boost/openmethod/macros.hpp>].
96

@@ -13,7 +10,7 @@ BOOST_OPENMETHOD_INLINE_OVERRIDE(ID, (PARAMETERS...), RETURN_TYPE) {
1310
}
1411
```
1512

16-
### Description
13+
## Description
1714

1815
`BOOST_OPENMETHOD_INLINE_OVERRIDE` performs the same function as
1916
xref:BOOST_OPENMETHOD_OVERRIDE.adoc[BOOST_OPENMETHOD_OVERRIDE], except that the

0 commit comments

Comments
 (0)