Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r73925 - in sandbox/conversion/boost/conversion: . boost std type_traits
From: vicente.botet_at_[hidden]
Date: 2011-08-19 13:28:40


Author: viboes
Date: 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
New Revision: 73925
URL: http://svn.boost.org/trac/boost/changeset/73925

Log:
conversion: update comments
Text files modified:
   sandbox/conversion/boost/conversion/assign_to.hpp | 8 ++++----
   sandbox/conversion/boost/conversion/boost/array.hpp | 14 +++++++++-----
   sandbox/conversion/boost/conversion/boost/chrono_duration_to_posix_time_duration.hpp | 13 ++++++++-----
   sandbox/conversion/boost/conversion/boost/chrono_time_point_to_posix_time_ptime.hpp | 14 +++++++++-----
   sandbox/conversion/boost/conversion/boost/interval.hpp | 15 +++++++++------
   sandbox/conversion/boost/conversion/boost/optional.hpp | 13 ++++++++-----
   sandbox/conversion/boost/conversion/boost/rational.hpp | 14 ++++++++------
   sandbox/conversion/boost/conversion/boost/tuple.hpp | 13 ++++++++-----
   sandbox/conversion/boost/conversion/is_extrinsically_assignable.hpp | 2 +-
   sandbox/conversion/boost/conversion/is_extrinsically_convertible.hpp | 2 +-
   sandbox/conversion/boost/conversion/is_extrinsically_explicitly_convertible.hpp | 4 ++--
   sandbox/conversion/boost/conversion/std/pair.hpp | 12 +++++++-----
   sandbox/conversion/boost/conversion/std/string.hpp | 7 +++++--
   sandbox/conversion/boost/conversion/std/vector.hpp | 7 +++++--
   sandbox/conversion/boost/conversion/type_traits/is_assignable.hpp | 2 +-
   sandbox/conversion/boost/conversion/type_traits/is_constructible.hpp | 2 +-
   sandbox/conversion/boost/conversion/type_traits/is_destructible.hpp | 2 +-
   sandbox/conversion/boost/conversion/type_traits/is_explicitly_convertible.hpp | 4 +---
   18 files changed, 88 insertions(+), 60 deletions(-)

Modified: sandbox/conversion/boost/conversion/assign_to.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/assign_to.hpp (original)
+++ sandbox/conversion/boost/conversion/assign_to.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -17,7 +17,7 @@
  *
  * The default behavior uses the assignment operator when the @c Target is assignable from the @c Source,
  * or makes an implicit conversion of the @c Source before assignment when the @c Source is
- * implicitly convertible to @c Target.
+ * extrinsically implicitly convertible to @c Target.
  *
  * When the default behavior is not satisfactory or doesn't takes care of
  * specific types, the user could customize the behavior of
@@ -73,13 +73,13 @@
 
     /**
      * Specialization when @c Target is not assignable from @c Source, but
- * @c Target is copy constructible and @c Source is extrinsic convertible to
+ * @c Target is copy constructible and @c Source is extrinsically convertible to
      * @c Target.
      *
      * @tparam Target target type of the conversion.
      * @tparam Source source type of the conversion.
      *
- * @Requires @c Target must be CopyAssinable and @c @c Source must be extrinsic convertible to @c Target.
+ * @Requires @c Target must be CopyAssinable and @c @c Source must be extrinsically convertible to @c Target.
      */
     template < typename Target, typename Source>
     struct assigner<Target, Source
@@ -191,7 +191,7 @@
      * @tparam N the size of the c-arrays.
      *
      * @Requires @c Target must be CopyAssinable and @c @c Source must be
- * extrinsic convertible to @c Target.
+ * extrinsically convertible to @c Target.
      */
     template < typename Target, typename Source, std::size_t N >
     struct assigner<Target[N],Source[N]

Modified: sandbox/conversion/boost/conversion/boost/array.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/array.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/array.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -30,11 +30,6 @@
 
 
 namespace boost {
-#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_array{};
-#endif
-
   namespace conversion {
 
     /**
@@ -125,7 +120,16 @@
       }
     };
   }
+
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct array{};
+ }
+#endif
 }
 
+
 #endif
 

Modified: sandbox/conversion/boost/conversion/boost/chrono_duration_to_posix_time_duration.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/chrono_duration_to_posix_time_duration.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/chrono_duration_to_posix_time_duration.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -27,11 +27,6 @@
 #include <boost/config.hpp>
 
 namespace boost {
-#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_chrono_duration{};
-#endif
-
   namespace conversion {
     //! @brief @c implicit_converter specialization for conversions from @c boost::chrono::duration<> to @c boost::posix_time::time_duration.
     //!
@@ -71,6 +66,14 @@
     };
 
   }
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct chrono_duration_to_posix_time_duration{};
+ }
+#endif
+
 }
 
 #endif

Modified: sandbox/conversion/boost/conversion/boost/chrono_time_point_to_posix_time_ptime.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/chrono_time_point_to_posix_time_ptime.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/chrono_time_point_to_posix_time_ptime.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -28,11 +28,6 @@
 #include <boost/config.hpp>
 
 namespace boost {
- #if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_chrono_time_point{};
- #endif
-
   namespace conversion {
 
     template < typename Duration>
@@ -70,7 +65,16 @@
       }
     };
   }
+
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace trick_doxygen
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct chrono_time_point_to_posix_time_ptime{};
+ }
+#endif
 }
 
+
 #endif
 //]

Modified: sandbox/conversion/boost/conversion/boost/interval.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/interval.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/interval.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -22,13 +22,8 @@
 #include <boost/conversion/assign_to.hpp>
 
 namespace boost {
- #if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_numeric_interval{};
- #endif
-
- namespace conversion {
 
+ namespace conversion {
     //! @brief @c implicit_converter specialization for source and target been @c boost::numeric::interval.
     //!
     template < typename Target, typename PTarget, typename Source, typename PSource>
@@ -70,6 +65,14 @@
       }
     };
   }
+
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct numeric_interval{};
+ }
+#endif
 }
 
 #endif

Modified: sandbox/conversion/boost/conversion/boost/optional.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/optional.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/optional.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -29,11 +29,6 @@
 
 
 namespace boost {
-#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_optional{};
-#endif
-
   namespace conversion {
 
     /**
@@ -133,6 +128,14 @@
     };
 
   }
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct optional{};
+ }
+#endif
+
 }
 
 #endif

Modified: sandbox/conversion/boost/conversion/boost/rational.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/rational.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/rational.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -26,12 +26,6 @@
 #include <boost/utility/enable_if.hpp>
 
 namespace boost {
-
-#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_rational{};
-#endif
-
   namespace conversion {
 
     //! @brief @c implicit_converter specialization for source and target been @c boost::rational.
@@ -75,6 +69,14 @@
       }
     };
   }
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct rational{};
+ }
+#endif
+
 }
 
 #endif

Modified: sandbox/conversion/boost/conversion/boost/tuple.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/boost/tuple.hpp (original)
+++ sandbox/conversion/boost/conversion/boost/tuple.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -22,11 +22,6 @@
 #include <boost/config.hpp>
 
 namespace boost {
-#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_fusion_tuple{};
-#endif
-
   namespace conversion {
 
     template < typename T1, typename T2, typename S1, typename S2>
@@ -80,6 +75,14 @@
     };
 
   }
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct tuple{};
+ }
+#endif
+
 }
 
 #endif

Modified: sandbox/conversion/boost/conversion/is_extrinsically_assignable.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/is_extrinsically_assignable.hpp (original)
+++ sandbox/conversion/boost/conversion/is_extrinsically_assignable.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -31,7 +31,7 @@
      * @Requires @c Target and @c Source must be complete types, (possibly cv-qualified) void, or arrays of unknown bound.
      *
      * @Remark
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation.
+ * - On compilers supporting SFINAE for expressions the library provided a valid implementation.
      * - Otherwise, the trait is equivalent to @c boost::conversion::assigner<Target,Source>.
      *
      */

Modified: sandbox/conversion/boost/conversion/is_extrinsically_convertible.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/is_extrinsically_convertible.hpp (original)
+++ sandbox/conversion/boost/conversion/is_extrinsically_convertible.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -31,7 +31,7 @@
      * @Requires @c Target and @c Source must be complete types, (possibly cv-qualified) void, or arrays of unknown bound.
      *
      * @Remark
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation.
+ * - On compilers supporting SFINAE for expressions the library provided a valid implementation.
      * - Otherwise, the trait is equivalent to @c boost::conversion::implicit_converter<Target,Source>.
      */
     template <typename Source, typename Target>

Modified: sandbox/conversion/boost/conversion/is_extrinsically_explicitly_convertible.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/is_extrinsically_explicitly_convertible.hpp (original)
+++ sandbox/conversion/boost/conversion/is_extrinsically_explicitly_convertible.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -19,7 +19,7 @@
 namespace boost {
   namespace conversion {
     /**
- * States if @c Source is extrinsically explicit convertible to @c Target.
+ * States if @c Source is extrinsically explicitly convertible to @c Target.
      *
      * @Condition: @c true_type if and only if the return expression in the following code
      * would be well-formed:
@@ -31,7 +31,7 @@
      * @Requires @c Target and @c Source must be complete types, (possibly cv-qualified) void, or arrays of unknown bound.
      *
      * @Remark
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation.
+ * - On compilers supporting SFINAE for expressions the library provided a valid implementation.
      * - Otherwise, the trait is equivalent to @c boost::conversion::explicit_converter<Target,Source>.
      */
     template <class Source, class Target>

Modified: sandbox/conversion/boost/conversion/std/pair.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/std/pair.hpp (original)
+++ sandbox/conversion/boost/conversion/std/pair.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -25,11 +25,6 @@
 
 
 namespace boost {
-#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_pair{};
-#endif
-
   namespace conversion {
 
     // std namespace can not be overloaded
@@ -84,6 +79,13 @@
         }
     };
   }
+#if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct pair{};
+ }
+#endif
 }
 
 #endif

Modified: sandbox/conversion/boost/conversion/std/string.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/std/string.hpp (original)
+++ sandbox/conversion/boost/conversion/std/string.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -30,8 +30,11 @@
 
 namespace boost {
 #if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_string{};
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct string{};
+ }
 #endif
 
   namespace conversion {

Modified: sandbox/conversion/boost/conversion/std/vector.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/std/vector.hpp (original)
+++ sandbox/conversion/boost/conversion/std/vector.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -26,8 +26,11 @@
 
 namespace boost {
 #if defined(BOOST_CONVERSION_DOXYGEN_INVOKED)
- //! trick to generate the doc. Don't take care of it
- struct trick_vector{};
+ namespace doxygen_trick
+ {
+ //! trick to generate the doc. Don't take care of it
+ struct vector{};
+ }
 #endif
   
   namespace conversion {

Modified: sandbox/conversion/boost/conversion/type_traits/is_assignable.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/type_traits/is_assignable.hpp (original)
+++ sandbox/conversion/boost/conversion/type_traits/is_assignable.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -29,7 +29,7 @@
    * @Remark
    * - On compilers providing an intrinsic for this trait, the intrinsic will be used.
    * - On C++0x mode, @c std::is_assignable will be used when available.
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation.
+ * - On compilers supporting SFINAE for expressions the library provided a valid implementation.
    * - Otherwise,
    * - the library will provide specialization for the builtin types in this file,
    * - the library will provide specialization for specific standard types in the associated @c type_traits/std/file.hpp

Modified: sandbox/conversion/boost/conversion/type_traits/is_constructible.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/type_traits/is_constructible.hpp (original)
+++ sandbox/conversion/boost/conversion/type_traits/is_constructible.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -34,7 +34,7 @@
    * @Remark
    * - On compilers providing an intrinsic for this trait, the intrinsic will be used.
    * - On C++0x mode, @c std::is_constructible will be used when available.
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation.
+ * - On compilers supporting SFINAE for expressions the library provided a valid implementation.
    * - Otherwise,
    * - the library will provide specialization for the builtin types in this file,
    * - the library will provide specialization for specific standard types in the associated @c type_traits/std/file.hpp

Modified: sandbox/conversion/boost/conversion/type_traits/is_destructible.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/type_traits/is_destructible.hpp (original)
+++ sandbox/conversion/boost/conversion/type_traits/is_destructible.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -42,7 +42,7 @@
    * @Remark
    * - On compilers providing an intrinsic for this trait, the intrinsic will be used.
    * - On C++0x mode, @c std::is_destructible will be used when available.
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation.
+ * - On compilers supporting SFINAE for expressions the library provided a valid implementation.
    * - Otherwise,
    * - the library will provide specialization for the builtin types in this file,
    * - the library will provide specialization for specific standard types in the associated @c type_traits/std/file.hpp

Modified: sandbox/conversion/boost/conversion/type_traits/is_explicitly_convertible.hpp
==============================================================================
--- sandbox/conversion/boost/conversion/type_traits/is_explicitly_convertible.hpp (original)
+++ sandbox/conversion/boost/conversion/type_traits/is_explicitly_convertible.hpp 2011-08-19 13:28:37 EDT (Fri, 19 Aug 2011)
@@ -37,9 +37,7 @@
    * was accepted.
    *
    * @Remark
- * - On compilers providing an intrinsic for this trait, the intrinsic will be used.
- * - On C++0x mode, @c std::is_assignable will be used when available.
- * - On compilers supporting SFINAE_EXPR or DECLTYPE the library provided a valid implementation using the @c static_cast version
+ * - On compilers supporting SFINAE_EXPR the library provided a valid implementation using the @c static_cast version
    * - Otherwise it relies on the @c is_constructible version.
    */
   template < typename Source, typename Target>


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