public inbox for libstdc++-cvs@sourceware.org help / color / mirror / Atom feed
From: Jonathan Wakely <redi@gcc.gnu.org> To: gcc-cvs@gcc.gnu.org, libstdc++-cvs@gcc.gnu.org Subject: [gcc r10-9669] libstdc++: Fix Doxygen warnings Date: Thu, 8 Apr 2021 14:12:42 +0000 (GMT) [thread overview] Message-ID: <20210408141242.62039394CC23@sourceware.org> (raw) https://gcc.gnu.org/g:3854e53a9393123fcc15c1cefb634b96066f7cba commit r10-9669-g3854e53a9393123fcc15c1cefb634b96066f7cba Author: Jonathan Wakely <jwakely@redhat.com> Date: Tue Apr 6 16:24:06 2021 +0100 libstdc++: Fix Doxygen warnings libstdc++-v3/ChangeLog: * include/bits/alloc_traits.h: Use markdown for code font. * include/bits/basic_string.h: Fix @param names. * include/bits/regex.h: Fix duplicate @retval names, and rename. * include/ext/pb_ds/detail/priority_queue_base_dispatch.hpp: Add group open to match existing group close. * include/ext/pb_ds/priority_queue.hpp: Add blank line before group open. (cherry picked from commit daef4e4d934716b933fa445a0ec6650aeb642751) Diff: --- libstdc++-v3/include/bits/alloc_traits.h | 2 +- libstdc++-v3/include/bits/basic_string.h | 6 +++--- libstdc++-v3/include/bits/regex.h | 16 ++++++++-------- .../ext/pb_ds/detail/priority_queue_base_dispatch.hpp | 6 ++++++ libstdc++-v3/include/ext/pb_ds/priority_queue.hpp | 3 ++- 5 files changed, 20 insertions(+), 13 deletions(-) diff --git a/libstdc++-v3/include/bits/alloc_traits.h b/libstdc++-v3/include/bits/alloc_traits.h index 86d8ed221ff..4fcaa533f46 100644 --- a/libstdc++-v3/include/bits/alloc_traits.h +++ b/libstdc++-v3/include/bits/alloc_traits.h @@ -341,7 +341,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION { __a.deallocate(__p, __n); } /** - * @brief Construct an object of type @a _Tp + * @brief Construct an object of type `_Tp` * @param __a An allocator. * @param __p Pointer to memory of suitable size and alignment for Tp * @param __args Constructor arguments. diff --git a/libstdc++-v3/include/bits/basic_string.h b/libstdc++-v3/include/bits/basic_string.h index 0b893bcea85..ab9fb04c451 100644 --- a/libstdc++-v3/include/bits/basic_string.h +++ b/libstdc++-v3/include/bits/basic_string.h @@ -4672,9 +4672,9 @@ _GLIBCXX_END_NAMESPACE_CXX11 /** * @brief Insert a string_view. - * @param __pos Position in string to insert at. - * @param __svt The object convertible to string_view to insert from. - * @param __pos Position in string_view to insert + * @param __pos1 Position in string to insert at. + * @param __svt The object convertible to string_view to insert from. + * @param __pos2 Position in string_view to insert * from. * @param __n The number of characters to insert. * @return Reference to this string. diff --git a/libstdc++-v3/include/bits/regex.h b/libstdc++-v3/include/bits/regex.h index 43d0ddb61bf..aa442e17656 100644 --- a/libstdc++-v3/include/bits/regex.h +++ b/libstdc++-v3/include/bits/regex.h @@ -915,9 +915,9 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11 * * @param __s Another matched sequence to compare to this one. * - * @retval <0 this matched sequence will collate before @p __s. - * @retval =0 this matched sequence is equivalent to @p __s. - * @retval <0 this matched sequence will collate after @p __s. + * @retval negative This matched sequence will collate before `__s`. + * @retval zero This matched sequence is equivalent to `__s`. + * @retval positive This matched sequence will collate after `__s`. */ int compare(const sub_match& __s) const @@ -925,13 +925,13 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11 /** * @{ - * @brief Compares this sub_match to a string. + * @brief Compares this `sub_match` to a string. * - * @param __s A string to compare to this sub_match. + * @param __s A string to compare to this `sub_match`. * - * @retval <0 this matched sequence will collate before @p __s. - * @retval =0 this matched sequence is equivalent to @p __s. - * @retval <0 this matched sequence will collate after @p __s. + * @retval negative This matched sequence will collate before `__s`. + * @retval zero This matched sequence is equivalent to `__s`. + * @retval positive This matched sequence will collate after `__s`. */ int compare(const string_type& __s) const diff --git a/libstdc++-v3/include/ext/pb_ds/detail/priority_queue_base_dispatch.hpp b/libstdc++-v3/include/ext/pb_ds/detail/priority_queue_base_dispatch.hpp index ec94b0d978d..9fec9a078cb 100644 --- a/libstdc++-v3/include/ext/pb_ds/detail/priority_queue_base_dispatch.hpp +++ b/libstdc++-v3/include/ext/pb_ds/detail/priority_queue_base_dispatch.hpp @@ -63,6 +63,12 @@ namespace __gnu_pbds { namespace detail { + /** + * @ingroup pbds + * + * @{ + */ + /// Specialization for pairing_heap. template<typename _VTp, typename Cmp_Fn, typename _Alloc> struct container_base_dispatch<_VTp, Cmp_Fn, _Alloc, pairing_heap_tag, diff --git a/libstdc++-v3/include/ext/pb_ds/priority_queue.hpp b/libstdc++-v3/include/ext/pb_ds/priority_queue.hpp index 987d08bec27..6dca5e1a6f6 100644 --- a/libstdc++-v3/include/ext/pb_ds/priority_queue.hpp +++ b/libstdc++-v3/include/ext/pb_ds/priority_queue.hpp @@ -51,6 +51,7 @@ namespace __gnu_pbds /** * @defgroup heap-based Heap-Based * @ingroup containers-pbds + * * @{ */ @@ -151,6 +152,6 @@ namespace __gnu_pbds swap(priority_queue& other) { base_type::swap(other); } }; -} // namespace __gnu_pbds ///@} heap-based +} // namespace __gnu_pbds #endif
reply other threads:[~2021-04-08 14:12 UTC|newest] Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210408141242.62039394CC23@sourceware.org \ --to=redi@gcc.gnu.org \ --cc=gcc-cvs@gcc.gnu.org \ --cc=libstdc++-cvs@gcc.gnu.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
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).