* [PATCH] Fixes to Doxygen comments in libstdc++ headers
@ 2017-05-17 16:27 Jonathan Wakely
0 siblings, 0 replies; only message in thread
From: Jonathan Wakely @ 2017-05-17 16:27 UTC (permalink / raw)
To: libstdc++, gcc-patches
[-- Attachment #1: Type: text/plain, Size: 570 bytes --]
Nothing very interesting, I noticed a few Doxygen warnings while
building the docs.
* 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.
Committed to trunk.
[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 8165 bytes --]
commit a9465eeeb29c699b88c2f22728a4a5cd248aecad
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Wed May 17 11:26:40 2017 +0100
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.
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.
*
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2017-05-17 16:03 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-17 16:27 [PATCH] Fixes to Doxygen comments in libstdc++ headers Jonathan Wakely
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).