Subject: [Boost-commit] svn:boost r81732 - trunk/boost/tti
From: eldiener_at_[hidden]
Date: 2012-12-05 22:23:22
Author: eldiener
Date: 2012-12-05 22:23:21 EST (Wed, 05 Dec 2012)
New Revision: 81732
URL: http://svn.boost.org/trac/boost/changeset/81732
Log:
Updated doxygen documentation.
Text files modified:
trunk/boost/tti/has_member_data.hpp | 24 ++++++++++++++++--------
trunk/boost/tti/has_member_function.hpp | 40 ++++++++++++++++++++++++----------------
trunk/boost/tti/has_static_member_function.hpp | 24 ++++++++++++++----------
3 files changed, 54 insertions(+), 34 deletions(-)
Modified: trunk/boost/tti/has_member_data.hpp
==============================================================================
--- trunk/boost/tti/has_member_data.hpp (original)
+++ trunk/boost/tti/has_member_data.hpp 2012-12-05 22:23:21 EST (Wed, 05 Dec 2012)
@@ -41,12 +41,16 @@
The metafunction types and return:
- TTI_T = the enclosing type in which to look for our 'name'.
+ TTI_T = the enclosing type in which to look for our 'name'
+ OR
+ The type of the member data in the form of a pointer
+ to member data.
- TTI_Type = the type of the member data.
+ TTI_Type = (optional) The type of the member data if the first
+ parameter is the enclosing type.
- returns = 'value' is true if the 'name' exists, with the TTI_Type data type,
- within the enclosing TTI_T type, otherwise 'value' is false.
+ returns = 'value' is true if the 'name' exists, with the correct data type,
+ otherwise 'value' is false.
*/
#define BOOST_TTI_TRAIT_HAS_MEMBER_DATA(trait,name) \
@@ -81,12 +85,16 @@
The metafunction types and return:
- TTI_T = the enclosing type in which to look for our 'name'.
+ TTI_T = the enclosing type in which to look for our 'name'
+ OR
+ The type of the member data in the form of a pointer
+ to member data.
- TTI_Type = the type of the member data.
+ TTI_Type = (optional) The type of the member data if the first
+ parameter is the enclosing type.
- returns = 'value' is true if the 'name' exists, with the TTI_Type data type,
- within the enclosing TTI_T type, otherwise 'value' is false.
+ returns = 'value' is true if the 'name' exists, with the correct data type,
+ otherwise 'value' is false.
*/
#define BOOST_TTI_HAS_MEMBER_DATA(name) \
Modified: trunk/boost/tti/has_member_function.hpp
==============================================================================
--- trunk/boost/tti/has_member_function.hpp (original)
+++ trunk/boost/tti/has_member_function.hpp 2012-12-05 22:23:21 EST (Wed, 05 Dec 2012)
@@ -42,18 +42,22 @@
The metafunction types and return:
- TTI_T = the enclosing type in which to look for our 'name'.
+ TTI_T = the enclosing type in which to look for our 'name'
+ OR
+ a pointer to member function as a single type.
+
+ TTI_R = (optional) the return type of the member function
+ if the first parameter is the enclosing type.
+
+ TTI_FS = (optional) the parameters of the member function as a boost::mpl forward sequence
+ if the first parameter is the enclosing type and the member function parameters
+ are not empty.
- TTI_R = the return type of the member function.
-
- TTI_FS = an optional parameter which are the parameters of the member function as a boost::mpl forward sequence.
-
- TTI_TAG = an optional parameter which is a boost::function_types tag to apply to the member function.
+ TTI_TAG = (optional) a boost::function_types tag to apply to the member function
+ if the first parameter is the enclosing type and a tag is needed.
returns = 'value' is true if the 'name' exists,
with the appropriate member function type,
- as defined by TTI_R, TTI_FS, and TTI_TAG,
- within the enclosing TTI_T type,
otherwise 'value' is false.
*/
@@ -82,18 +86,22 @@
The metafunction types and return:
- TTI_T = the enclosing type in which to look for our 'name'.
-
- TTI_R = the return type of the member function.
-
- TTI_FS = an optional parameter which are the parameters of the member function as a boost::mpl forward sequence.
+ TTI_T = the enclosing type in which to look for our 'name'
+ OR
+ a pointer to member function as a single type.
+
+ TTI_R = (optional) the return type of the member function
+ if the first parameter is the enclosing type.
+
+ TTI_FS = (optional) the parameters of the member function as a boost::mpl forward sequence
+ if the first parameter is the enclosing type and the member function parameters
+ are not empty.
- TTI_TAG = an optional parameter which is a boost::function_types tag to apply to the member function.
+ TTI_TAG = (optional) a boost::function_types tag to apply to the member function
+ if the first parameter is the enclosing type and a tag is needed.
returns = 'value' is true if the 'name' exists,
with the appropriate member function type,
- as defined by TTI_R, TTI_FS, and TTI_TAG,
- within the enclosing TTI_T type,
otherwise 'value' is false.
*/
Modified: trunk/boost/tti/has_static_member_function.hpp
==============================================================================
--- trunk/boost/tti/has_static_member_function.hpp (original)
+++ trunk/boost/tti/has_static_member_function.hpp 2012-12-05 22:23:21 EST (Wed, 05 Dec 2012)
@@ -42,16 +42,18 @@
TTI_T = the enclosing type in which to look for our 'name'.
- TTI_R = the return type of the static member function.
+ TTI_R = the return type of the static member function
+ OR
+ the signature of a function in the form of Return_Type ( Parameter_Types )
- TTI_FS = an optional parameter which are the parameters of the static member function as a boost::mpl forward sequence.
+ TTI_FS = (optional) the parameters of the static member function as a boost::mpl forward sequence
+ if the second parameter is a return type and the function parameters exist.
- TTI_TAG = an optional parameter which is a boost::function_types tag to apply to the static member function.
+ TTI_TAG = (optional) a boost::function_types tag to apply to the static member function
+ if the second parameter is a return type and the need for a tag exists.
returns = 'value' is true if the 'name' exists,
with the appropriate static member function type,
- as defined by TTI_R, TTI_FS, and TTI_TAG,
- within the enclosing TTI_T type,
otherwise 'value' is false.
*/
@@ -82,16 +84,18 @@
TTI_T = the enclosing type in which to look for our 'name'.
- TTI_R = the return type of the static member function.
+ TTI_R = the return type of the static member function
+ OR
+ the signature of a function in the form of Return_Type ( Parameter_Types )
- TTI_FS = an optional parameter which are the parameters of the static member function as a boost::mpl forward sequence.
+ TTI_FS = (optional) the parameters of the static member function as a boost::mpl forward sequence
+ if the second parameter is a return type and the function parameters exist.
- TTI_TAG = an optional parameter which is a boost::function_types tag to apply to the static member function.
+ TTI_TAG = (optional) a boost::function_types tag to apply to the static member function
+ if the second parameter is a return type and the need for a tag exists.
returns = 'value' is true if the 'name' exists,
with the appropriate static member function type,
- as defined by TTI_R, TTI_FS, and TTI_TAG,
- within the enclosing TTI_T type,
otherwise 'value' is false.
*/