X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=ceph%2Fsrc%2Fboost%2Fboost%2Fcontract%2Foverride.hpp;h=f6881ccfd01f643f824416c3ff783628917b3b86;hb=92f5a8d42d07f9929ae4fa7e01342fe8d96808a8;hp=96a4ceafbccd68f3df07d35fe58b0e391464023c;hpb=a0324939f9d0e1905d5df8f57442f09dc70af83d;p=ceph.git
diff --git a/ceph/src/boost/boost/contract/override.hpp b/ceph/src/boost/boost/contract/override.hpp
index 96a4ceafb..f6881ccfd 100644
--- a/ceph/src/boost/boost/contract/override.hpp
+++ b/ceph/src/boost/boost/contract/override.hpp
@@ -18,20 +18,21 @@ Handle public function overrides (for subcontracting).
#ifdef BOOST_CONTRACT_DETAIL_DOXYGEN
/**
- Declare an override type with an arbitrary name.
+ Declare an override type trait with an arbitrary name.
- Declare the override type to pass as an explicit template parameter to
- @RefFunc{boost::contract::public_function} for public function overrides.
+ Declare the override type trait named @c type_name to pass as an explicit
+ template parameter to @RefFunc{boost::contract::public_function} for public
+ function overrides.
@see @RefSect{advanced.named_overrides, Named Overrides}
- @param type_name Name of the override type this macro will declare.
+ @param type_name Name of the override type trait this macro will declare.
(This is not a variadic macro parameter but it should
never contain commas because it is an identifier.)
@param func_name Function name of the public function override.
This macro is called just once even if the function name
- is overloaded (the same override type is used for all
- overloaded functions with the same name, see
+ is overloaded (the same override type trait is used for
+ all overloaded functions with the same name, see
@RefSect{advanced.function_overloads,
Function Overloads}).
(This is not a variadic macro parameter but it should
@@ -113,17 +114,21 @@ Handle public function overrides (for subcontracting).
/* PUBLIC */
/**
-Declare an override type named override_func_name.
+Declare an override type trait named override_func_name.
-Declare the override type to pass as an explicit template parameter to
-@RefFunc{boost::contract::public_function} for public function overrides.
+Declare the override type trait named override_func_name to pass
+as an explicit template parameter to @RefFunc{boost::contract::public_function}
+for public function overrides.
+Use @RefMacro{BOOST_CONTRACT_NAMED_OVERRIDE} to generate an override type trait
+with a name different than override_func_name (usually not
+needed).
@see @RefSect{tutorial.public_function_overrides__subcontracting_,
Public Function Overrides}
@param func_name Function name of the public function override.
This macro is called just once even if the function name is
- overloaded (the same override type is used for all
+ overloaded (the same override type trait is used for all
overloaded functions with the same name, see
@RefSect{advanced.function_overloads, Function Overloads}).
(This is not a variadic macro parameter but it should never
@@ -134,10 +139,10 @@ Declare the override type to pass as an explicit template parameter to
#ifdef BOOST_CONTRACT_DETAIL_DOXYGEN
/**
- Declare multiple override types at once naming them override_... (for
- convenience).
+ Declare multiple override type traits at once naming them
+ override_... (for convenience).
- This variadic macro is provided for convenience only,
+ This variadic macro is provided for convenience as
BOOST_CONTRACT_OVERRIDES(f_1, f_2, ..., f_n) expands to code
equivalent to:
@@ -149,7 +154,7 @@ Declare the override type to pass as an explicit template parameter to
@endcode
On compilers that do not support variadic macros,
- the override types can be equivalently programmed one-by-one calling
+ the override type traits can be equivalently programmed one-by-one calling
@RefMacro{BOOST_CONTRACT_OVERRIDE} for each function name as shown above.
@see @RefSect{tutorial.public_function_overrides__subcontracting_,