Fixes to Doxygen comments in libstdc++ headers
authorJonathan Wakely <jwakely@redhat.com>
Wed, 17 May 2017 16:02:33 +0000 (17:02 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Wed, 17 May 2017 16:02:33 +0000 (17:02 +0100)
* include/bits/refwrap.h: Fix Doxygen warning.
* include/bits/specfun.h: Likewise.
* include/bits/std_function.h: Likewise.
* include/bits/stl_algo.h (set_union, set_intersection)
(set_difference, set_symmetric_difference): Add Doxygen @param tags
for output iterator parameters.
* include/bits/stl_iterator.h (inserter): Add Doxygen @param tag for
iterator parameter.
* include/std/mutex (try_lock, lock): Change Mutex to Lockable in
Doxygen comments.

From-SVN: r248160

libstdc++-v3/ChangeLog
libstdc++-v3/include/bits/refwrap.h
libstdc++-v3/include/bits/specfun.h
libstdc++-v3/include/bits/std_function.h
libstdc++-v3/include/bits/stl_algo.h
libstdc++-v3/include/bits/stl_iterator.h
libstdc++-v3/include/bits/string_view.tcc
libstdc++-v3/include/std/mutex

index 98d363acc2e1202fe6d9fa8eb871ac72573c5d5c..132f9ee8b4edac47259486307e611f0aa759d5e0 100644 (file)
@@ -1,3 +1,16 @@
+2017-05-17  Jonathan Wakely  <jwakely@redhat.com>
+
+       * include/bits/refwrap.h: Fix Doxygen warning.
+       * include/bits/specfun.h: Likewise.
+       * include/bits/std_function.h: Likewise.
+       * include/bits/stl_algo.h (set_union, set_intersection)
+       (set_difference, set_symmetric_difference): Add Doxygen @param tags
+       for output iterator parameters.
+       * include/bits/stl_iterator.h (inserter): Add Doxygen @param tag for
+       iterator parameter.
+       * include/std/mutex (try_lock, lock): Change Mutex to Lockable in
+       Doxygen comments.
+
 2017-05-17  Ville Voutilainen  <ville.voutilainen@gmail.com>
 
        Implement new C++ intrinsics __is_assignable and __is_constructible.
index 786087e8d8fa538d88eb2268aadc7777db0024df..5e5b61060e357b249704defadff0ff0942617102 100644 (file)
@@ -22,7 +22,7 @@
 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 // <http://www.gnu.org/licenses/>.
 
-/** @file include/bits/bind.h
+/** @file include/bits/refwrap.h
  *  This is an internal header file, included by other library headers.
  *  Do not attempt to use it directly. @headername{functional}
  */
index 6dd23d2c4ce42d52d9f33616bf8c1b6ef25565a0..82bd02e227a88ee00c85e608ac49a042d199b3aa 100644 (file)
@@ -118,8 +118,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
    * versions of this math library because of implementation concerns.
    * However, since they were in the TR1 version and since they are popular
    * we kept them as an extension in namespace @c __gnu_cxx:
-   * - @ref conf_hyperg "conf_hyperg - Confluent hypergeometric functions"
-   * - @ref hyperg "hyperg - Hypergeometric functions"
+   * - @ref __gnu_cxx::conf_hyperg "conf_hyperg - Confluent hypergeometric functions"
+   * - @ref __gnu_cxx::hyperg "hyperg - Hypergeometric functions"
    *
    * @section general General Features
    *
index b393a944818f30604a62ee4e9529e4f140874965..c4ea34733609d5f5da47d0ded3188c5c371df9c7 100644 (file)
@@ -22,7 +22,7 @@
 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 // <http://www.gnu.org/licenses/>.
 
-/** @file include/bits/function.h
+/** @file include/bits/std_function.h
  *  This is an internal header file, included by other library headers.
  *  Do not attempt to use it directly. @headername{functional}
  */
index 2cd5303a100b998f80369c0baf2cd39aedf14b52..aaa4eefbe9a76975da932755a51aa064d0df76a8 100644 (file)
@@ -5103,6 +5103,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
    *
@@ -5151,6 +5152,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @param  __comp    The comparison functor.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
@@ -5223,6 +5225,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
    *
@@ -5269,6 +5272,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @param  __comp    The comparison functor.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
@@ -5341,6 +5345,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
    *
@@ -5389,6 +5394,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @param  __comp    The comparison functor.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
@@ -5471,6 +5477,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
    *
@@ -5519,6 +5526,7 @@ _GLIBCXX_BEGIN_NAMESPACE_ALGO
    *  @param  __last1   End of first range.
    *  @param  __first2  Start of second range.
    *  @param  __last2   End of second range.
+   *  @param  __result  Start of output range.
    *  @param  __comp    The comparison functor.
    *  @return  End of the output range.
    *  @ingroup set_algorithms
index e6ef784ce19569dfd0922c31866f6b43da3d6cae..18c6e3f625e2af5a967dbb07898323ef7f450fde 100644 (file)
@@ -721,6 +721,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
   /**
    *  @param __x  A container of arbitrary type.
+   *  @param __i  An iterator into the container.
    *  @return  An instance of insert_iterator working on @p __x.
    *
    *  This wrapper function helps in creating insert_iterator instances.
index ffdcc30cae3d10cb0865939b7b18ceecc1ca213d..f4bd50fd4a064f8722fdd53f871078448554dc3b 100644 (file)
@@ -22,7 +22,7 @@
 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 // <http://www.gnu.org/licenses/>.
 
-/** @file bits/string_view.tcc
+/** @file include/bits/string_view.tcc
  *  This is an internal header file, included by other library headers.
  *  Do not attempt to use it directly. @headername{string_view}
  */
index 6c3f92022beb3e779d0482aa14632a86683fe972..df48b4605711bee1c2e17d9d12e68244516a0df7 100644 (file)
@@ -507,9 +507,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
     };
 
   /** @brief Generic try_lock.
-   *  @param __l1 Meets Mutex requirements (try_lock() may throw).
-   *  @param __l2 Meets Mutex requirements (try_lock() may throw).
-   *  @param __l3 Meets Mutex requirements (try_lock() may throw).
+   *  @param __l1 Meets Lockable requirements (try_lock() may throw).
+   *  @param __l2 Meets Lockable requirements (try_lock() may throw).
+   *  @param __l3 Meets Lockable requirements (try_lock() may throw).
    *  @return Returns -1 if all try_lock() calls return true. Otherwise returns
    *          a 0-based index corresponding to the argument that returned false.
    *  @post Either all arguments are locked, or none will be.
@@ -527,9 +527,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
     }
 
   /** @brief Generic lock.
-   *  @param __l1 Meets Mutex requirements (try_lock() may throw).
-   *  @param __l2 Meets Mutex requirements (try_lock() may throw).
-   *  @param __l3 Meets Mutex requirements (try_lock() may throw).
+   *  @param __l1 Meets Lockable requirements (try_lock() may throw).
+   *  @param __l2 Meets Lockable requirements (try_lock() may throw).
+   *  @param __l3 Meets Lockable requirements (try_lock() may throw).
    *  @throw An exception thrown by an argument's lock() or try_lock() member.
    *  @post All arguments are locked.
    *