Fixes to Doxygen comments in libstdc++ headers

Message ID	20170517160314.GA28096@redhat.com
State	New
Headers	show Return-Path: <gcc-patches-return-453889-incoming=patchwork.ozlabs.org@gcc.gnu.org> DomainKey-Signature: a=rsa-sha1; c=nofws; d=gcc.gnu.org; h=list-id :list-unsubscribe:list-archive:list-post:list-help:sender:date :from:to:subject:message-id:mime-version:content-type; q=dns; s= default; b=tJdiFGOYJW0xV4gX+4gyWPOw6Kr/QQTw5nNlp5lP+56vB2rOh/nJO BsKd8iZ6vR1nLbBlttHbBDgDbaR0LQl4Hu4A242QR+kvwKzQHs6lg0ohY5i6/aKR jTurxfmpde7eQoqF0ICMd44QsR6B3ipEvRmYbeYUQpz7xL6H/ge3u4= Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm Precedence: bulk Sender: gcc-patches-owner@gcc.gnu.org DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com D3C974DB15 Date: Wed, 17 May 2017 17:03:14 +0100 From: Jonathan Wakely <jwakely@redhat.com> To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org Subject: [PATCH] Fixes to Doxygen comments in libstdc++ headers Message-ID: <20170517160314.GA28096@redhat.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="+QahgC5+KEYLbs62" Content-Disposition: inline User-Agent: Mutt/1.8.0 (2017-02-23)

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. *

Fixes to Doxygen comments in libstdc++ headers

Commit Message

Patch