[Boost-commit] svn:boost r62399 - sandbox/SOC/2010/bit_masks/lib/integer/doc

Subject: [Boost-commit] svn:boost r62399 - sandbox/SOC/2010/bit_masks/lib/integer/doc
From: bbartmanboost_at_[hidden]
Date: 2010-06-03 10:22:20

Author: bbartman
Date: 2010-06-03 10:22:18 EDT (Thu, 03 Jun 2010)
New Revision: 62399
URL: http://svn.boost.org/trac/boost/changeset/62399

Log:
working on documentation
Text files modified: 
   sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2        |     1 +                                       
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk     |     7 ++-----                                 
   sandbox/SOC/2010/bit_masks/lib/integer/doc/integral_mask.qbk |    36 ++++++++++++++++++++++++------------    
   3 files changed, 27 insertions(+), 17 deletions(-)

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2	(original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2	2010-06-03 10:22:18 EDT (Thu, 03 Jun 2010)
@@ -8,6 +8,7 @@
 using quickbook ;
 
 xml bit_masks_doc : bit_masks.qbk ;
+#xml integral_mask_doc : integral_mask.qbk ;
 boostbook standalone
     :
         bit_masks_doc

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk	(original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk	2010-06-03 10:22:18 EDT (Thu, 03 Jun 2010)
@@ -19,7 +19,7 @@
    [
       [`Integral_mask` type]
       [ [^[@http://svn.boost.org/svn/boost/sandbox/SOC/2010/bit_masks/boost/integer/integral_mask.hpp <boost/integer/integral_mask.hpp>]]]
-      [Forward declarations of classes and class templates - for use when just the name of a class is needed.]
+      [ Header contains `integral_mask` type]
    ]
 ]
 
@@ -61,8 +61,5 @@
 
 [endsect]
 
-[section:integral_mask `integral_mask` type]
-This type is used for composing the most basic masks.
-
-[endsect]
+[include:integral_mask integral_mask.qbk]
 

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/integral_mask.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/integral_mask.qbk	(original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/integral_mask.qbk	2010-06-03 10:22:18 EDT (Thu, 03 Jun 2010)
@@ -1,14 +1,26 @@
-[article Integral_mask
-    [quickbook 1.5]
-    [copyright 2010 Brian Bartman]
-    [purpose Bit Mask Selection]
-    [license
-        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])
-    ]
-    [authors [Bartman, Brian]]
-]
-
+[c++]
 [section:integral_mask integral_mask type]
+[h3 Description]
+The `integral_mask` type is the most basic mask type. It is used to abstract all
+masks back to a simple integral type. This type is used similar to an
+`integral_constant` type from the boost.type_traits library.
+
+
+[h3 Template Signature]
+`integral_mask` has the following template signature:
+``
+template <typename T, T Value>
+struct integral_mask;
+``
+[h3 Interface]
+`Integral_mask` Compile time interface. Assume that N is of type
+`integral_mask<int, 16>` the type supplied here is only for example.
+
+[table
+    [[Operation][Description]]
+    [[`N::value`][Returns the value associated with N (in the current case that is 16). ]]
+    [[`N::value_type`][Returns the type of the value associated with N (in the current case that is int). ]]
+    [[`N::type`][ Returns the current types type (using N as an example, `N::type` is equivalent to `integral_mask<int,16>` )]]
+]
 [endsect]
+