[Boost-commit] svn:boost r73902 - sandbox/SOC/2011/checks/boost/checks

Subject: [Boost-commit] svn:boost r73902 - sandbox/SOC/2011/checks/boost/checks
From: pierre.talbot.6114_at_[hidden]
Date: 2011-08-18 18:19:55

Author: trademark
Date: 2011-08-18 18:19:54 EDT (Thu, 18 Aug 2011)
New Revision: 73902
URL: http://svn.boost.org/trac/boost/changeset/73902

Log:
Add documentation.
Text files modified: 
   sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp |    47 +++++++++++++++++++++++++++++++++++++++ 
   1 files changed, 46 insertions(+), 1 deletions(-)

Modified: sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp	2011-08-18 18:19:54 EDT (Thu, 18 Aug 2011)
@@ -5,6 +5,11 @@
 //  http://www.boost.org/LICENSE_1_0.txt
 //  See http://www.boost.org for updates, documentation, and revision history.
 
+/*! \file iteration_sense.hpp
+    \brief Provides two sense of iteration to run through the sequence from right to left or left to right.
+*/
+
+
 #ifndef BOOST_CHECK_ITERATION_SENSE_HPP
 #define BOOST_CHECK_ITERATION_SENSE_HPP
 
@@ -21,32 +26,72 @@
 namespace boost{
   namespace checks{
 
+/*! \class rightmost
+    \brief Policy class that provides methods to run through a sequence from right to left.
+*/
 struct rightmost
 {
+  /*! \class iterator
+      \brief Template rebinding class used to define the type of a const reverse iterator for seq_range.
+
+      \tparam seq_range The type of the sequence to check.
+  */
   template <typename seq_range>
   struct iterator
   {
     typedef typename boost::range_const_reverse_iterator<seq_range>::type type ;
   };
 
+  /*! \fn static typename iterator<seq_range>::type begin(seq_range &sequence)
+      \brief Get the beginning of the sequence.
+
+      \tparam seq_range The type of the sequence to check.
+      \returns A reverse iterator represents the beginning of the sequence.
+  */
   template <typename seq_range>
   static typename iterator<seq_range>::type begin(seq_range &sequence) { return boost::rbegin(sequence) ; }
 
+  /*! \fn static typename iterator<seq_range>::type end(seq_range &sequence)
+      \brief Get the ending of the sequence.
+
+      \tparam seq_range The type of the sequence to check.
+      \returns A reverse iterator represents one pass the end of the sequence.
+  */
   template <typename seq_range>
   static typename iterator<seq_range>::type end(seq_range &sequence)   { return boost::rend(sequence) ; }
 };
 
+/*! \class leftmost
+    \brief Policy class that provides methods to run through a sequence from left to right.
+*/
 struct leftmost
 {
+  /*! \class iterator
+      \brief Template rebinding class used to define the type of a const iterator for seq_range.
+
+      \tparam seq_range The type of the sequence to check.
+  */
   template <typename seq_range>
   struct iterator
   {
     typedef typename boost::range_const_iterator<seq_range>::type type ;
   };
 
+  /*! \fn static typename iterator<seq_range>::type begin(seq_range &sequence)
+      \brief Get the beginning of the sequence.
+
+      \tparam seq_range The type of the sequence to check.
+      \returns An iterator represents the beginning of the sequence.
+  */
   template <typename seq_range>
   static typename iterator<seq_range>::type begin(seq_range &sequence) { return boost::begin(sequence) ; }
-
+  
+  /*! \fn static typename iterator<seq_range>::type end(seq_range &sequence)
+      \brief Get the ending of the sequence.
+
+      \tparam seq_range The type of the sequence to check.
+      \returns An iterator represents one pass the end of the sequence.
+  */
   template <typename seq_range>
   static typename iterator<seq_range>::type end(seq_range &sequence)   { return boost::end(sequence) ; }
 };