Skip to content

Commit c2f9871

Browse files
committed
more doc work
1 parent 21c8ca3 commit c2f9871

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

doc/modules/ROOT/pages/BOOST_OPENMETHOD.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
Defined in <boost/openmethod/macros.hpp>.
77

88
```c++
9-
BOOST_OPENMETHOD(NAME, (PARAMETERS...), RETURN_TYPE [, POLICY]);
9+
BOOST_OPENMETHOD(NAME, (PARAMETERS...), RETURN_TYPE [, REGISTRY]);
1010
```
1111

1212
### Description
1313

14-
Declares a method.
14+
Declare a method.
1515

1616
The macro expands to several constructs:
1717

@@ -24,18 +24,18 @@ struct BOOST_OPENMETHOD_ID(NAME);
2424
* An inline function template, constrained to take the same `PARAMETERS`,
2525
without the `virtual_` decorators, returning a `RETURN_TYPE`. The function
2626
forwards to +
27-
`method<BOOST_OPENMETHOD_ID(NAME)(PARAMETERS...), RETURN_TYPE, POLICY>::fn`.
27+
`method<BOOST_OPENMETHOD_ID(NAME)(PARAMETERS...), RETURN_TYPE, REGISTRY>::fn`.
2828

2929
* A guide function used to match overriders with the method:
3030

3131
```c++
3232
auto BOOST_OPENMETHOD_ID(NAME)_guide(...)
3333
-> ::boost::openmethod::method<
34-
BOOST_OPENMETHOD_ID(NAME)(PARAMETERS...), RETURN_TYPE [, POLICY]>;
34+
BOOST_OPENMETHOD_ID(NAME)(PARAMETERS...), RETURN_TYPE [, REGISTRY]>;
3535
```
3636

3737
NOTE: `NAME` must be an *identifier*. Qualified names are not allowed.
3838

39-
NOTE: The default value for `POLICY` is the value of
39+
NOTE: The default value for `REGISTRY` is the value of
4040
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` at the point `<boost/openmethod/core.hpp>` is
4141
included. Changing the value of this symbol has no effect after that point.

doc/modules/ROOT/pages/BOOST_OPENMETHOD_CLASSES.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88
Defined in <boost/openmethod/macros.hpp>.
99

1010
```c++
11-
BOOST_OPENMETHOD_CLASSES(CLASSES...[, POLICY]);
11+
BOOST_OPENMETHOD_CLASSES(CLASSES...[, REGISTRY]);
1212
```
1313

1414
### Description
1515

16-
Registers `CLASSES` in POLICY.
16+
Registers `CLASSES` in REGISTRY.
1717

18-
NOTE: The default value for `POLICY` is the value of
18+
NOTE: The default value for `REGISTRY` is the value of
1919
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` when `<boost/openmethod/core.hpp>` is
2020
included. Subsequently changing it has no retroactive effect.
2121

doc/modules/ROOT/pages/BOOST_OPENMETHOD_DECLARE_OVERRIDER.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Defined in <boost/openmethod/macros.hpp>.
1111

1212
### Description
1313

14-
Declares an overrider for a method.
14+
Declare an overrider for a method.
1515

1616
The method is deduced from a call to a method guide function with the
1717
overrider's arguments.

doc/modules/ROOT/pages/BOOST_OPENMETHOD_DEFAULT_REGISTRY.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Defined in `&lt;https://www.github.com/boostorg/openmethod/blob/develop/include/
1414

1515
The name of the default registry.
1616

17-
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` is the default value for the `Policy` template
17+
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` is the default value for the `REGISTRY` template
1818
parameter of `method`, `use_classes`, and other constructs defined in
1919
`<boost/openmethod/core.hpp>`. If it is not defined,
20-
`::boost::openmethod::policy::default_registry` is used.
20+
`::boost::openmethod::REGISTRY::default_registry` is used.
2121

2222
`BOOST_OPENMETHOD_DEFAULT_REGISTRY` can be defined by a program to change the
23-
default policy globally. Once `<boost/openmethod/core.hpp>` has been included,
24-
redefining the symbol has no effect. To override the default policy, proceed as
23+
default REGISTRY globally. Once `<boost/openmethod/core.hpp>` has been included,
24+
redefining the symbol has no effect. To override the default REGISTRY, proceed as
2525
follows:
2626

2727
1. Include headers under `boost/openmethod/policies/` as needed.
28-
2. Create a policy class, and set `BOOST_OPENMETHOD_DEFAULT_REGISTRY`.
28+
2. Create a REGISTRY class, and set `BOOST_OPENMETHOD_DEFAULT_REGISTRY`.
2929
3. Include `<boost/openmethod/core.hpp>`.

doc/modules/ROOT/pages/BOOST_OPENMETHOD_DEFINE_OVERRIDER.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Defined in <boost/openmethod/macros.hpp>.
1111

1212
### Description
1313

14-
Defines the body of an overrider declared with
14+
Define the body of an overrider declared with
1515
`BOOST_OPENMETHOD_DECLARE_OVERRIDER`. It should be called in an implementation
1616
file, and followed by a function body.
1717

test/test_virtual_ptr_doc.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ BOOST_AUTO_TEST_CASE(virtual_ptr_examples) {
2222
// clang-format on
2323

2424
{
25-
virtual_ptr<Dog> p{nullptr};`
25+
virtual_ptr<Dog> p{nullptr};
2626

2727
BOOST_TEST(p.get() == nullptr);
2828
BOOST_TEST(p.vptr() == nullptr);

0 commit comments

Comments
 (0)