From: Jonathan Wakely <jwakely@redhat.com>
To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org
Subject: [committed] libstdc++: Fix Doxygen warnings
Date: Tue, 6 Apr 2021 16:54:07 +0100 [thread overview]
Message-ID: <YGyEHy5tw0PrJX3p@redhat.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 494 bytes --]
libstdc++-v3/ChangeLog:
* include/bits/alloc_traits.h: Use markdown for code font.
* include/bits/basic_string.h: Fix @param names.
* include/bits/max_size_type.h: Remove period after @file.
* 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.
Tested powerpc64le-linux. Committed to trunk.
[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 5678 bytes --]
commit daef4e4d934716b933fa445a0ec6650aeb642751
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Tue Apr 6 16:24:06 2021
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/max_size_type.h: Remove period after @file.
* 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.
diff --git a/libstdc++-v3/include/bits/alloc_traits.h b/libstdc++-v3/include/bits/alloc_traits.h
index 2c69e5a2b35..34412583064 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 bfc97644bd0..7d819bb1bb7 100644
--- a/libstdc++-v3/include/bits/basic_string.h
+++ b/libstdc++-v3/include/bits/basic_string.h
@@ -4707,9 +4707,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/max_size_type.h b/libstdc++-v3/include/bits/max_size_type.h
index 27d63797c49..153b1bff5f4 100644
--- a/libstdc++-v3/include/bits/max_size_type.h
+++ b/libstdc++-v3/include/bits/max_size_type.h
@@ -22,7 +22,7 @@
// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
// <http://www.gnu.org/licenses/>.
-/** @file bits/max_size_type.h.
+/** @file bits/max_size_type.h
* This is an internal header file, included by other library headers.
* Do not attempt to use it directly. @headername{iterator}
*/
diff --git a/libstdc++-v3/include/bits/regex.h b/libstdc++-v3/include/bits/regex.h
index 4d331c82e74..ac10fa184c6 100644
--- a/libstdc++-v3/include/bits/regex.h
+++ b/libstdc++-v3/include/bits/regex.h
@@ -916,9 +916,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
@@ -926,13 +926,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 c2f69f9228d..e3dac058f5f 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 8ff1784cad2..bbd375d5d5e 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-06 15:54 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=YGyEHy5tw0PrJX3p@redhat.com \
--to=jwakely@redhat.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=libstdc++@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: link
Be 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).