Subject: [Boost-commit] svn:boost r62400 - sandbox/SOC/2010/bit_masks/lib/integer/doc
From: bbartmanboost_at_[hidden]
Date: 2010-06-03 10:36:20
Author: bbartman
Date: 2010-06-03 10:36:20 EDT (Thu, 03 Jun 2010)
New Revision: 62400
URL: http://svn.boost.org/trac/boost/changeset/62400
Log:
addint template parameter descriptions to my documentation
Text files modified:
sandbox/SOC/2010/bit_masks/lib/integer/doc/integral_mask.qbk | 15 ++++++++++++++-
1 files changed, 14 insertions(+), 1 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 10:36:20 EDT (Thu, 03 Jun 2010)
@@ -12,15 +12,28 @@
template <typename T, T Value>
struct integral_mask;
``
+[table
+ [[Parameter][Description]]
+ [[`T`][This Parameters specifies the integral type to be associated with the value.]]
+ [[`value`][ The integral value which is used to represent a 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`][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.]]
]
+
+
+[h3 Examples]
+Examples and use cases related to the `integral_mask` type.
+
+
[endsect]