Boost logo

Boost-Commit :

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


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

Log:
working on integral_mask docuentation

Text files modified:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/integral_mask.qbk | 16 +++++++++++-----
   1 files changed, 11 insertions(+), 5 deletions(-)

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 11:12:34 EDT (Thu, 03 Jun 2010)
@@ -14,7 +14,8 @@
 ``
 [table
     [[Parameter][Description]]
- [[`T`][This Parameters specifies the integral type to be associated with the value.]]
+ [[`T`][This Parameters specifies the integral type to be associated with the
+value.]]
     [[`value`][ The integral value which is used to represent a mask.]]
 ]
 
@@ -24,10 +25,15 @@
 
 [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>` )]]
- [[`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.]]
+ [[`N::value`][Returns the `value` associated with `N` (in the current case
+that is 16). ]]
+ [[`N::value_type`][Returns `T` or the type associated with `value` inside `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>` )]]
+ [[`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.]]
 ]
 
 


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk