any (any_cast): Combine duplicate doxygen comments.
authorJonathan Wakely <jwakely@redhat.com>
Sat, 14 Jun 2014 20:43:07 +0000 (21:43 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Sat, 14 Jun 2014 20:43:07 +0000 (21:43 +0100)
* include/experimental/any (any_cast): Combine duplicate doxygen
comments.
* include/experimental/string_view (basic_string_view): Update
doxygen comment.
* include/std/bitset (bitset): Move to Doxygen 'utilities' group.
* include/tr2/dynamic_bitset (_Bool2UChar): Remove unused templates.
(dynamic_bitset): Improve Doxygen comments.
* include/tr2/dynamic_bitset.tcc (operator>>): Improve Doxygen
comment.

From-SVN: r211672

libstdc++-v3/ChangeLog
libstdc++-v3/include/experimental/any
libstdc++-v3/include/experimental/string_view
libstdc++-v3/include/std/bitset
libstdc++-v3/include/tr2/dynamic_bitset
libstdc++-v3/include/tr2/dynamic_bitset.tcc

index 43f9697b63c118505c76fe3a6fe58909236bca2b..5f23ef09e16b6277b6ea4bd1d95c53c763188d63 100644 (file)
        * include/std/streambuf: Likewise.
        * doc/html/*: Regenerate.
 
+       * include/experimental/any (any_cast): Combine duplicate doxygen
+       comments.
+       * include/experimental/string_view (basic_string_view): Update
+       doxygen comment.
+       * include/std/bitset (bitset): Move to Doxygen 'utilities' group.
+       * include/tr2/dynamic_bitset (_Bool2UChar): Remove unused templates.
+       (dynamic_bitset): Improve Doxygen comments.
+       * include/tr2/dynamic_bitset.tcc (operator>>): Improve Doxygen
+       comment.
+
 2014-06-11  Maciej W. Rozycki  <macro@codesourcery.com>
 
        * testsuite/27_io/basic_ostream/inserters_arithmetic/wchar_t/4402.cc
index 2839af1eae60c374a9783fe607d065df55e61d70..1e8d9b2f7d12af52b7fda50c1ccfd2c8ef62a841 100644 (file)
@@ -81,11 +81,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
   }
 
   /**
-    * @brief A type-safe container of any type.
-    *
-    * An @c any object's state is either empty or it stores a contained object
-    * of CopyConstructible type.
-    */
+    @brief A type-safe container of any type.
+   * 
+    An @c any object's state is either empty or it stores a contained object
+    of CopyConstructible type.
+   */
   class any
   {
     // Holds either pointer to a heap object or the contained object itself.
@@ -391,6 +391,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
    * @throw   bad_any_cast If <code>
    *          __any.type() != typeid(remove_reference_t<_ValueType>)
    *          </code>
+   *
+   * @{
    */
   template<typename _ValueType>
     inline _ValueType any_cast(any& __any)
@@ -403,16 +405,6 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
       __throw_bad_any_cast();
     }
 
-  /**
-   * @brief Access the contained object.
-   *
-   * @tparam  _ValueType  A reference or CopyConstructible type.
-   * @param   __any       The object to access.
-   * @return  The contained object.
-   * @throw   bad_any_cast If <code>
-   *          __any.type() != typeid(remove_reference_t<_ValueType>)
-   *          </code>
-   */
   template<typename _ValueType>
     inline _ValueType any_cast(any&& __any)
     {
@@ -423,6 +415,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
        return *__p;
       __throw_bad_any_cast();
     }
+  // @}
 
   /**
    * @brief Access the contained object.
@@ -432,6 +425,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
    * @return  The address of the contained object if <code>
    *          __any != nullptr && __any.type() == typeid(_ValueType)
    *          </code>, otherwise a null pointer.
+   *
+   * @{
    */
   template<typename _ValueType>
     inline const _ValueType* any_cast(const any* __any) noexcept
@@ -441,15 +436,6 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
       return nullptr;
     }
 
-  /**
-   * @brief Access the contained object.
-   *
-   * @tparam  _ValueType  The type of the contained object.
-   * @param   __any       A pointer to the object to access.
-   * @return  The address of the contained object if <code>
-   *          __any != nullptr && __any.type() == typeid(_ValueType)
-   *          </code>, otherwise a null pointer.
-   */
   template<typename _ValueType>
     inline _ValueType* any_cast(any* __any) noexcept
     {
@@ -457,6 +443,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
        return static_cast<_ValueType*>(__any_caster<_ValueType>(__any));
       return nullptr;
     }
+  // @}
 
 #ifdef __GXX_RTTI
   template<typename _Tp, typename _Alloc>
index 49f46af544f03f7c6762686a0d2111101738b438..b54c9e85db8aacaf2ecadcf24ae2f4b1bc96e646 100644 (file)
@@ -49,11 +49,12 @@ namespace experimental
 _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
   /**
-   *  @class basic_string_view <string_view>
+   *  @class basic_string_view <experimental/string_view>
    *  @brief  A non-owning reference to a string.
    *
    *  @ingroup strings
    *  @ingroup sequences
+   *  @ingroup experimental
    *
    *  @tparam _CharT  Type of character
    *  @tparam _Traits  Traits for character type, defaults to
index b89a283f05c27ce0e5468e1bba86df4a34bdeff3..c58da822493ab027b755aa29857c7225c9895e49 100644 (file)
@@ -681,9 +681,10 @@ _GLIBCXX_BEGIN_NAMESPACE_CONTAINER
 #endif
 
   /**
-   *  The %bitset class represents a @e fixed-size sequence of bits.
+   *  @class bitset <bitset>
    *
-   *  @ingroup containers
+   *  @brief The %bitset class represents a @e fixed-size sequence of bits.
+   *  @ingroup utilities
    *
    *  (Note that %bitset does @e not meet the formal requirements of a
    *  <a href="tables.html#65">container</a>.  Mainly, it lacks iterators.)
index dba145b950e9ec6819c4d76cf71a3506e7deed0a..755584fdcef133e1b278f286fbf003e3547a1839 100644 (file)
@@ -47,28 +47,11 @@ namespace tr2
 _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
   /**
-   *  Dynamic Bitset.
+   *  @defgroup dynamic_bitset Dynamic Bitset.
+   *  @ingroup extensions
    *
-   *  See N2050,
-   *  Proposal to Add a Dynamically Sizeable Bitset to the Standard Library.
+   *  @{
    */
-namespace __detail
-{
-
-template<typename T>
-class _Bool2UChar
-{
-  typedef T type;
-};
-
-template<>
-class _Bool2UChar<bool>
-{
-public:
-  typedef unsigned char type;
-};
-
-}
 
   /**
    *  Base class, general case.
@@ -372,14 +355,8 @@ public:
   /**
    *  @brief  The %dynamic_bitset class represents a sequence of bits.
    *
-   *  @ingroup containers
-   *
-   *  (Note that %dynamic_bitset does @e not meet the formal
-   *  requirements of a <a href="tables.html#65">container</a>.
-   *  Mainly, it lacks iterators.)
-   *
-   *  The template argument, @a Nb, may be any non-negative number,
-   *  specifying the number of bits (e.g., "0", "12", "1024*1024").
+   *  See N2050,
+   *  Proposal to Add a Dynamically Sizeable Bitset to the Standard Library.
    *
    *  In the general unoptimized case, storage is allocated in
    *  word-sized blocks.  Let B be the number of bits in a word, then
@@ -409,7 +386,7 @@ public:
    *     int main()
    *     {
    *         long         a = 'a';
-   *         dynamic_bitset   b(a);
+   *         dynamic_bitset<> b(a);
    *
    *         cout << "b('a') is " << b << endl;
    *
@@ -421,10 +398,6 @@ public:
    *     }
    *  @endcode
    *
-   *  Also see:
-   *  http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt12ch33s02.html
-   *  for a description of extensions.
-   *
    *  Most of the actual code isn't contained in %dynamic_bitset<>
    *  itself, but in the base class __dynamic_bitset_base.  The base
    *  class works with whole words, not with individual bits.  This
@@ -1228,16 +1201,7 @@ public:
     }
   //@}
 
-  /**
-   *  @defgroup Global I/O operators for bitsets.
-   *  @{
-   *  @brief Global I/O operators for bitsets.
-   *
-   *  Direct I/O between streams and bitsets is supported.  Output is
-   *  straightforward.  Input will skip whitespace and only accept '0'
-   *  and '1' characters.  The %dynamic_bitset will grow as necessary
-   *  to hold the string of bits.
-   */
+  /// Stream output operator for dynamic_bitset.
   template <typename _CharT, typename _Traits,
            typename _WordT, typename _Alloc>
     inline std::basic_ostream<_CharT, _Traits>&
index d5b55ce6623140ff3a2f33dbb1ea0b7293430ff3..25f897e17d474a05f626cd2df8b6823e028b8009 100644 (file)
@@ -195,14 +195,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
       }
 
   /**
-   *  @defgroup Global I/O operators for bitsets.
-   *  @{
-   *  @brief Global I/O operators for bitsets.
+   *  @brief Stream input operator for dynamic_bitset.
+   *  @ingroup dynamic_bitset
    *
-   *  Direct I/O between streams and bitsets is supported.  Output is
-   *  straightforward.  Input will skip whitespace and only accept '0'
-   *  and '1' characters.  The %dynamic_bitset will grow as necessary
-   *  to hold the string of bits.
+   *  Input will skip whitespace and only accept '0' and '1' characters.
+   *  The %dynamic_bitset will grow as necessary to hold the string of bits.
    */
   template<typename _CharT, typename _Traits,
           typename _WordT, typename _Alloc>
@@ -275,9 +272,6 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
        __is.setstate(__state);
       return __is;
     }
-  /**
-   *  @}
-   */
 
 _GLIBCXX_END_NAMESPACE_VERSION
 } // tr2