aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3
diff options
context:
space:
mode:
authorJonathan Wakely <jwakely@redhat.com>2017-05-17 17:02:33 +0100
committerJonathan Wakely <redi@gcc.gnu.org>2017-05-17 17:02:33 +0100
commit26bddba34ab4735eba9f5a5da4399f348ce39674 (patch)
tree183b68df4e3d8fa39a33a57c2f1a766971d192fc /libstdc++-v3
parent539f481a292d606bd7cf092880c51412e95d92b6 (diff)
downloadgcc-26bddba34ab4735eba9f5a5da4399f348ce39674.zip
gcc-26bddba34ab4735eba9f5a5da4399f348ce39674.tar.gz
gcc-26bddba34ab4735eba9f5a5da4399f348ce39674.tar.bz2
Fixes to Doxygen comments in libstdc++ headers
* 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
Diffstat (limited to 'libstdc++-v3')
-rw-r--r--libstdc++-v3/ChangeLog13
-rw-r--r--libstdc++-v3/include/bits/refwrap.h2
-rw-r--r--libstdc++-v3/include/bits/specfun.h4
-rw-r--r--libstdc++-v3/include/bits/std_function.h2
-rw-r--r--libstdc++-v3/include/bits/stl_algo.h8
-rw-r--r--libstdc++-v3/include/bits/stl_iterator.h1
-rw-r--r--libstdc++-v3/include/bits/string_view.tcc2
-rw-r--r--libstdc++-v3/include/std/mutex12
8 files changed, 33 insertions, 11 deletions
diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog
index 98d363a..132f9ee 100644
--- a/libstdc++-v3/ChangeLog
+++ b/libstdc++-v3/ChangeLog
@@ -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.
diff --git a/libstdc++-v3/include/bits/refwrap.h b/libstdc++-v3/include/bits/refwrap.h
index 786087e..5e5b610 100644
--- a/libstdc++-v3/include/bits/refwrap.h
+++ b/libstdc++-v3/include/bits/refwrap.h
@@ -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}
*/
diff --git a/libstdc++-v3/include/bits/specfun.h b/libstdc++-v3/include/bits/specfun.h
index 6dd23d2..82bd02e 100644
--- a/libstdc++-v3/include/bits/specfun.h
+++ b/libstdc++-v3/include/bits/specfun.h
@@ -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
*
diff --git a/libstdc++-v3/include/bits/std_function.h b/libstdc++-v3/include/bits/std_function.h
index b393a94..c4ea347 100644
--- a/libstdc++-v3/include/bits/std_function.h
+++ b/libstdc++-v3/include/bits/std_function.h
@@ -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}
*/
diff --git a/libstdc++-v3/include/bits/stl_algo.h b/libstdc++-v3/include/bits/stl_algo.h
index 2cd5303..aaa4eef 100644
--- a/libstdc++-v3/include/bits/stl_algo.h
+++ b/libstdc++-v3/include/bits/stl_algo.h
@@ -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
diff --git a/libstdc++-v3/include/bits/stl_iterator.h b/libstdc++-v3/include/bits/stl_iterator.h
index e6ef784..18c6e3f 100644
--- a/libstdc++-v3/include/bits/stl_iterator.h
+++ b/libstdc++-v3/include/bits/stl_iterator.h
@@ -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.
diff --git a/libstdc++-v3/include/bits/string_view.tcc b/libstdc++-v3/include/bits/string_view.tcc
index ffdcc30..f4bd50f 100644
--- a/libstdc++-v3/include/bits/string_view.tcc
+++ b/libstdc++-v3/include/bits/string_view.tcc
@@ -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}
*/
diff --git a/libstdc++-v3/include/std/mutex b/libstdc++-v3/include/std/mutex
index 6c3f920..df48b46 100644
--- a/libstdc++-v3/include/std/mutex
+++ b/libstdc++-v3/include/std/mutex
@@ -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.
*