Subject: [Boost-commit] svn:boost r62409 - sandbox/SOC/2010/bit_masks/lib/integer/doc
From: bbartmanboost_at_[hidden]
Date: 2010-06-03 12:16:06
Author: bbartman
Date: 2010-06-03 12:16:05 EDT (Thu, 03 Jun 2010)
New Revision: 62409
URL: http://svn.boost.org/trac/boost/changeset/62409
Log:
created basic layout for other mask types.
Text files modified:
sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask.qbk | 47 ++++++++++++++++++++++++++++++++++++++++
sandbox/SOC/2010/bit_masks/lib/integer/doc/high_bits.qbk | 47 ++++++++++++++++++++++++++++++++++++++++
sandbox/SOC/2010/bit_masks/lib/integer/doc/low_bits.qbk | 47 ++++++++++++++++++++++++++++++++++++++++
3 files changed, 141 insertions(+), 0 deletions(-)
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask.qbk (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/bit_mask.qbk 2010-06-03 12:16:05 EDT (Thu, 03 Jun 2010)
@@ -0,0 +1,47 @@
+[c++]
+[section:MASKNAME MASKNAME]
+[h3 Description]
+
+
+[h3 Template Signature]
+`TYPENME` has the following template signature:
+``
+TEMPLATE SIGNATURE.
+``
+
+[table
+ [[Parameter][Description]]
+ [[][ ]]
+ [[][ ]]
+]
+
+[h3 Interface]
+`TYPENAME` Compile time interface. Assume that N is of type
+`N TYPE` the type supplied here is only for example.
+
+[table
+ [[Operation][Description]]
+ [[`N::value`][Returns the `value` associated with `N`. ]]
+ [[`N::value_type`][Returns `T` which is the type associated with `value` inside `N`. ]]
+ [[`N::type`][ Returns the current types type. ]]
+ [[`operator T()`][ Run time support function. All this function does is
+return the value associated with the type. With the c++0x feature constexper
+this function will be made fasters and more effieient.]]
+]
+
+
+[h3 Examples]
+Examples and use cases related to the `TYPENAME` type.
+
+
+Exaple:
+``
+ EXAMPLE
+``
+
+The implicit cast operator allows for simplicity, clairity of code. In the
+above example `mask()` could be replaced with `mask::value` to achieve the same
+result. The same applies to all other bitwise operators.
+
+[endsect]
+
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/high_bits.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/high_bits.qbk (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/high_bits.qbk 2010-06-03 12:16:05 EDT (Thu, 03 Jun 2010)
@@ -0,0 +1,47 @@
+[c++]
+[section:MASKNAME MASKNAME]
+[h3 Description]
+
+
+[h3 Template Signature]
+`TYPENME` has the following template signature:
+``
+TEMPLATE SIGNATURE.
+``
+
+[table
+ [[Parameter][Description]]
+ [[][ ]]
+ [[][ ]]
+]
+
+[h3 Interface]
+`TYPENAME` Compile time interface. Assume that N is of type
+`N TYPE` the type supplied here is only for example.
+
+[table
+ [[Operation][Description]]
+ [[`N::value`][Returns the `value` associated with `N`. ]]
+ [[`N::value_type`][Returns `T` which is the type associated with `value` inside `N`. ]]
+ [[`N::type`][ Returns the current types type. ]]
+ [[`operator T()`][ Run time support function. All this function does is
+return the value associated with the type. With the c++0x feature constexper
+this function will be made fasters and more effieient.]]
+]
+
+
+[h3 Examples]
+Examples and use cases related to the `TYPENAME` type.
+
+
+Exaple:
+``
+ EXAMPLE
+``
+
+The implicit cast operator allows for simplicity, clairity of code. In the
+above example `mask()` could be replaced with `mask::value` to achieve the same
+result. The same applies to all other bitwise operators.
+
+[endsect]
+
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/low_bits.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/low_bits.qbk (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/low_bits.qbk 2010-06-03 12:16:05 EDT (Thu, 03 Jun 2010)
@@ -0,0 +1,47 @@
+[c++]
+[section:MASKNAME MASKNAME]
+[h3 Description]
+
+
+[h3 Template Signature]
+`TYPENME` has the following template signature:
+``
+TEMPLATE SIGNATURE.
+``
+
+[table
+ [[Parameter][Description]]
+ [[][ ]]
+ [[][ ]]
+]
+
+[h3 Interface]
+`TYPENAME` Compile time interface. Assume that N is of type
+`N TYPE` the type supplied here is only for example.
+
+[table
+ [[Operation][Description]]
+ [[`N::value`][Returns the `value` associated with `N`. ]]
+ [[`N::value_type`][Returns `T` which is the type associated with `value` inside `N`. ]]
+ [[`N::type`][ Returns the current types type. ]]
+ [[`operator T()`][ Run time support function. All this function does is
+return the value associated with the type. With the c++0x feature constexper
+this function will be made fasters and more effieient.]]
+]
+
+
+[h3 Examples]
+Examples and use cases related to the `TYPENAME` type.
+
+
+Exaple:
+``
+ EXAMPLE
+``
+
+The implicit cast operator allows for simplicity, clairity of code. In the
+above example `mask()` could be replaced with `mask::value` to achieve the same
+result. The same applies to all other bitwise operators.
+
+[endsect]
+