[Boost-commit] svn:boost r63386 - sandbox/SOC/2010/bit_masks/boost/integer/details/bft

Subject: [Boost-commit] svn:boost r63386 - sandbox/SOC/2010/bit_masks/boost/integer/details/bft
From: bbartmanboost_at_[hidden]
Date: 2010-06-27 10:44:50

Author: bbartman
Date: 2010-06-27 10:44:48 EDT (Sun, 27 Jun 2010)
New Revision: 63386
URL: http://svn.boost.org/trac/boost/changeset/63386

Log:
adding additional documentation to the template expansion macros so I remember what patterns come from which macros
Text files modified: 
   sandbox/SOC/2010/bit_masks/boost/integer/details/bft/make_bitfield_tuple.hpp       |    29 +++++++++++++++++++++++++++++           
   sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp |    24 ++++++++++++++++++++----                
   2 files changed, 49 insertions(+), 4 deletions(-)

Modified: sandbox/SOC/2010/bit_masks/boost/integer/details/bft/make_bitfield_tuple.hpp
==============================================================================
--- sandbox/SOC/2010/bit_masks/boost/integer/details/bft/make_bitfield_tuple.hpp	(original)
+++ sandbox/SOC/2010/bit_masks/boost/integer/details/bft/make_bitfield_tuple.hpp	2010-06-27 10:44:48 EDT (Sun, 27 Jun 2010)
@@ -0,0 +1,29 @@
+//  Copyright 2010 Brian Bartman.
+//  Distributed under the Boost Software License, Version 1.0.
+//  (See accompanying file LICENSE_1_0.txt or copy at 
+//  http://www.boost.org/LICENSE_1_0.txt)
+
+
+#ifndef BOOST_MEMBER_FIELD_HPP
+#define BOOST_MEMBER_FIELD_HPP
+#include <cstddef>
+
+
+namespace boost {
+
+/** There are 2 types of functions used for creating bitfields.
+ *  The first is a static implementation where by the initial value of
+ *  the data is set at compile time. The second is a runtime create bitfield
+ *  where by the values are set at runtime.
+ */
+
+
+/** Static create bitfield.
+ *  Compile time initilization of a bitfield tuple. This creates a bitfield
+ *  with an initial value of that is specified on compile time.
+ */
+template <
+
+} // end boost
+
+#endif

Modified: sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp
==============================================================================
--- sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp	(original)
+++ sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp	2010-06-27 10:44:48 EDT (Sun, 27 Jun 2010)
@@ -42,7 +42,6 @@
 #       else
 #           error "BOOST_BFT_PARAM_COUNT of value greater then 50 not supported."
 #       endif
-#       
 #   else
 #       if BOOST_BFT_PARAM_COUNT <= BOOST_MPL_LIMIT_VECTOR_SIZE
 #       else
@@ -58,6 +57,9 @@
 /** Creates variadic tempalte behavior by creating parameters up to
  *  BOOST_BFT_PARAM_COUNT in the fasion of typename TN = mpl::void_, ... 
  *  where N is the Nth parameter in the parameter list.
+ *
+ *  Creates the following pattern
+ *      typename T0 = mpl::void_, ... typename TN = mpl::void_
  */
 #define BOOST_MAKE_BFT_TEMPLATE_PARAMS() \
             BOOST_PP_ENUM(  BOOST_BFT_PARAM_COUNT,\
@@ -79,6 +81,8 @@
 
 /** Defines code for the unpacking and parsing of template parameters.
  *  This is used within the bft_base_impl.
+ *  Creates the following pattern
+ *      ::template process<T1>::type ... ::template process<TN>::type
  */
 #define BOOST_BFT_UNPACK_PARAMS() \
         BOOST_PP_REPEAT_FROM_TO( \
@@ -98,26 +102,38 @@
 /** This is used for making a list of all of the template parameters and that 
  *  list of comma seperated parameters is then used to name the template within
  *  itself or to pass all of the template arguments at once.
+ *
+ *  Creates the following pattern
+ *     T0, ... TN
  */
 #define BOOST_BFT_PARAMETER_LIST() \
             BOOST_PP_ENUM(  BOOST_BFT_PARAM_COUNT,\
                             BOOST_BFT_PARAM_LIST, \
                             T )
 
-/** Creates the template parameters for the bft_base_class. */
+/** Creates the template parameters for the bft base or impl class.
+ *  Creates the following pattern
+ *      typename T0, ... typename TN
+ */
 #define BOOST_BFT_BASE_TEMPLATE_PARAMS() \
     BOOST_PP_ENUM(  BOOST_BFT_PARAM_COUNT,\
                     BOOST_BFT_PARAM_LIST, \
                     typename T )
 
-/** Used for creating template parameter for*/
+/** Used for creating template parameters for specilization.
+ *  Creates the following pattern
+ *      typename T0, ... typename TN
+ */
 #define BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS() \
     BOOST_PP_ENUM(  BOOST_BFT_PARAM_COUNT,\
                     BOOST_BFT_PARAM_LIST, \
                     typename T )
 
 
-/** Used for specilizing over the bitfield_tuple sequence. */
+/** Used for specilizing over the bitfield_tuple sequence.
+ *  Creates the following pattern
+ *      T0, ... TN
+ */
 #define BOOST_BFT_SPECILIZATION_PARAM_LIST() \
                 BOOST_BFT_PARAMETER_LIST()
 #endif