[Boost-commit] svn:boost r63545 - sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/macro_reference

Subject: [Boost-commit] svn:boost r63545 - sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/macro_reference
From: bbartmanboost_at_[hidden]
Date: 2010-07-03 11:47:52

Author: bbartman
Date: 2010-07-03 11:47:51 EDT (Sat, 03 Jul 2010)
New Revision: 63545
URL: http://svn.boost.org/trac/boost/changeset/63545

Log:
working on documentation. Completed work on the macro section, added preconditions to the class reference section and am now going to be adding the utility macros to the documentation next
Text files modified: 
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/macro_reference/bitfield_tuple_macros.qbk |    73 ++++++++++++++++++++++++++++++++++++++++
   1 files changed, 73 insertions(+), 0 deletions(-)

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/macro_reference/bitfield_tuple_macros.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/macro_reference/bitfield_tuple_macros.qbk	(original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/macro_reference/bitfield_tuple_macros.qbk	2010-07-03 11:47:51 EDT (Sat, 03 Jul 2010)
@@ -30,4 +30,77 @@
 
 [endsect]
 [section Code Generation Macros]
+[h5 Macros]
+Macros used for generating template parameters for use in specilization
+and generating template parameters. The `N` value in the below sequences below
+represent the value of `BOOST_BFT_PARAM_COUNT`.
+
+[table
+    [
+        [Name]
+        [Pattern]
+        [Usage]
+    ]
+    [
+        [`BOOST_MAKE_BFT_TEMPLATE_PARAMS()`]
+        [`typename T0 = mpl::void_, ... typename TN = mpl::void_`]
+        [ Internal use only. Used for creating the template parameter for the
+`bitfield_tuple`.]
+    ]
+    [
+        [`BOOST_BFT_UNPACK_PARAMS()`]
+        [`::template process<T1>::type ... ::template process<TN>::type`]
+        [ Internal use only. Used for parsing the template parameters from a
+`bitfield_tuple`. ]
+    ]
+    [
+        [`BOOST_BFT_PARAMETER_LIST()`]
+        [`T0, ... TN`]
+        [ Internal use only. This is used to create a bitfield tuple base type
+so that the number of parameters that gets passed to that is then the same
+as would be passed into the class. ]
+    ]
+    [
+        [`BOOST_BFT_BASE_TEMPLATE_PARAMS()`]
+        [`typename T0, ... typename TN`]
+        [ Internal use only. This macro generages the template parameters for
+the base class of the bitfield_tuple. ]
+    ]
+    [
+        [`BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS()`]
+        [`typename T0, ... typename TN`]
+        [ Recomended for use outside of `bitfield_tuple`. This macro is used to 
+create template parameters which can be used for specialization over a
+`bitfield_tuple` type. ]
+    ]
+    [
+        [`BOOST_BFT_SPECILIZATION_PARAM_LIST()`]
+        [`T0, ... TN`]
+        [ Recomended for use outside of `bitfield_tuple`. This macro is used to 
+create template parameters which are then supplied to the template of a
+`bitfield_tuple` type. ]
+    ]
+]
+
+Here is example useage of the macros that can be used to specilize a class
+template over the `btifield_tuple` type.
+
+``
+#include <boost/integer/bitfield_tuple.hpp>
+
+template <typename T>
+struct foo;
+
+
+template<BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS()>
+struct foo< boost::bitfield_tuple< BOOST_BFT_SPECILIZATION_PARAM_LIST() > >
+{
+};
+struct
+
+``
+
 [endsect]
+
+
+