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

Subject: [Boost-commit] svn:boost r62411 - sandbox/SOC/2010/bit_masks/lib/integer/doc
From: bbartmanboost_at_[hidden]
Date: 2010-06-03 12:17:29

Author: bbartman
Date: 2010-06-03 12:17:28 EDT (Thu, 03 Jun 2010)
New Revision: 62411
URL: http://svn.boost.org/trac/boost/changeset/62411

Log:
renaming files for clairity
Added:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/main.qbk
      - copied unchanged from r62406, /sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk
Removed:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk
Text files modified: 
   sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2 |     4 ++--                                    
   1 files changed, 2 insertions(+), 2 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 12:17:28 EDT (Thu, 03 Jun 2010)
@@ -7,8 +7,8 @@
 
 using quickbook ;
 
-xml bit_masks_doc : bit_masks.qbk ;
-#xml integral_mask_doc : integral_mask.qbk ;
+xml bit_masks_doc : main.qbk ;
+
 boostbook standalone
     :
         bit_masks_doc

Deleted: sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_masks.qbk	2010-06-03 12:17:28 EDT (Thu, 03 Jun 2010)
+++ (empty file)
@@ -1,65 +0,0 @@
-[article Boost.Integer Bits Masks Extension
-    [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]]
-]
-
-[section:HeaderSummary Header File Summary]
-The following table contains header files used within the bit masks library extension.
-For additional information such as full descriptions, tutorials and interface guides
-please use the table of contents above.
-[table
-   [[Component][Header][Contence]]
-   [
-      [`Integral_mask` type]
-      [ [^[@http://svn.boost.org/svn/boost/sandbox/SOC/2010/bit_masks/boost/integer/integral_mask.hpp <boost/integer/integral_mask.hpp>]]]
-      [ Header contains `integral_mask` type]
-   ]
-]
-
-[endsect]
-
-[section:bit_mask_purpose Purpose]
-The purpose of this library extension to the boost.integer library is to make
-the creation of simple and complex integral masks simple and easy and constructable on 
-compile time. The structure of the masks are extensions of the type `integral_constant`
-provided by boost.type_traits library. All masks are able to be treated as the 
-`integral_constant` type. All masks provide the following three compile time accessible
-features. They all provide `::type`,`::value_type` and `::value` for compile time
-support. This also means that all masks can be used with the boost.mpl bitwise 
-operator meta-functions for creation of more complex masks. Now because these values
-were intended to be used during the runtime of a program all of the masking types 
-which are provided by this library provide an additional functionality for run time
-support. All of the mask types in this library provide the implicit cast operator 
-allowing for the meta-function objects to be used as if they were the integral value
-they were used to construct. For example,
-[c++]
-``
-#include <boost/integer/integral_mask.hpp>
-
-using namespace boost;
-
-
-int main() {
-    int t = 0xdeadbeef;
-    typedef integral_mask<int, 3> mask_type;
-
-    int unmasked_t = t & mask_type();
-    return 0;
-}
-``
-For the use of a mask all that one needs to do is to construct the mask and 
-simply treat it as though it were an integer.
-
-[note All masks are trivially default constructible and destructible.]
-
-[endsect]
-
-[include:integral_mask integral_mask.qbk]
-