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

Subject: [Boost-commit] svn:boost r73938 - sandbox/SOC/2011/checks/boost/checks
From: pierre.talbot.6114_at_[hidden]
Date: 2011-08-19 20:06:04

Author: trademark
Date: 2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
New Revision: 73938
URL: http://svn.boost.org/trac/boost/changeset/73938

Log:
Correction of doxygen comments warning.
Text files modified: 
   sandbox/SOC/2011/checks/boost/checks/amex.hpp         |     2 +-                                      
   sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp |     9 ++++-----                               
   sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp   |    11 +++++++++++                             
   sandbox/SOC/2011/checks/boost/checks/isbn.hpp         |     2 +-                                      
   sandbox/SOC/2011/checks/boost/checks/mastercard.hpp   |     2 +-                                      
   sandbox/SOC/2011/checks/boost/checks/visa.hpp         |     2 +-                                      
   6 files changed, 19 insertions(+), 9 deletions(-)

Modified: sandbox/SOC/2011/checks/boost/checks/amex.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/amex.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/amex.hpp	2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
@@ -42,7 +42,7 @@
     \brief Verify that a number matches the amex pattern.
 
     \param current_valid_value is the current valid value analysed.
-    \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+    \param current_value_position is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
 
     \throws std::invalid_argument if the first character is not equal to 3 or the second is not equal to 4 or 7. The exception contains a descriptive message of what was expected.
 

Modified: sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp	2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
@@ -60,14 +60,13 @@
 
 /*! 
     \brief Create iterators according to the algorithm::iterator policy. And call the iterator overload version of compute_checksum.
-
-    \pre seq_begin and seq_end are valid iterators.
+   
+    \pre check_seq is a valid range.
 
     \tparam algorithm is a set of static method use to translate, filter and calculate or verify the checkdigit.
     \tparam size_contract is a contract concerning the size of the sequence.
-    \tparam iterator Must meet the InputIterator requirements.
-    \param seq_begin Beginning of the sequence.
-    \param seq_end Ending of the sequence.
+    \tparam check_range is a valid range type.
+    \param check_seq is the sequence of value to check.
 
     \throws size_contract::exception_size_failure If the terms of the contract are not respected.
 

Modified: sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp	2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
@@ -58,6 +58,17 @@
     #pragma once
 #endif
 
+#include <boost/checks/luhn.hpp>
+#include <boost/checks/verhoeff.hpp>
+#include <boost/checks/modulus11.hpp>
+#include <boost/checks/modulus97.hpp>
+#include <boost/checks/ean.hpp>
+#include <boost/checks/isbn.hpp>
+#include <boost/checks/upc.hpp>
+#include <boost/checks/amex.hpp>
+#include <boost/checks/visa.hpp>
+#include <boost/checks/mastercard.hpp>
+
 namespace boost{
   namespace checks{
 

Modified: sandbox/SOC/2011/checks/boost/checks/isbn.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/isbn.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/isbn.hpp	2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
@@ -45,7 +45,7 @@
     \brief Verify that a number matches the ISBN-13 pattern.
 
     \param current_valid_value is the current valid value analysed.
-    \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+    \param current_value_position is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
 
     \throws std::invalid_argument if the three first character are not equal to 978 or 979. The exception contains a descriptive message of what was expected.
 

Modified: sandbox/SOC/2011/checks/boost/checks/mastercard.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/mastercard.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/mastercard.hpp	2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
@@ -42,7 +42,7 @@
     \brief Verify that a number matches the Mastercard pattern.
 
     \param current_valid_value is the current valid value analysed.
-    \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+    \param current_value_position is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
 
     \throws std::invalid_argument if the first character is not equal to 5 or the second is not between 1 and 5. The exception contains a descriptive message of what was expected.
 

Modified: sandbox/SOC/2011/checks/boost/checks/visa.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/visa.hpp	(original)
+++ sandbox/SOC/2011/checks/boost/checks/visa.hpp	2011-08-19 20:06:03 EDT (Fri, 19 Aug 2011)
@@ -42,7 +42,7 @@
     \brief Verify that a number matches the Visa pattern.
 
     \param current_valid_value is the current valid value analysed.
-    \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+    \param current_value_position is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
 
     \throws std::invalid_argument if the first character is not equal to 4. The exception contains a descriptive message of what was expected.