public inbox for libstdc++-cvs@sourceware.org
help / color / mirror / Atom feed
* [gcc r9-9332] libstdc++: Fix Doxygen warnings
@ 2021-04-08 23:38 Jonathan Wakely
0 siblings, 0 replies; only message in thread
From: Jonathan Wakely @ 2021-04-08 23:38 UTC (permalink / raw)
To: gcc-cvs, libstdc++-cvs
https://gcc.gnu.org/g:1d400074e054d613caef796b130a1aa2ef4ec6f8
commit r9-9332-g1d400074e054d613caef796b130a1aa2ef4ec6f8
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 | 7 +++----
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(+), 14 deletions(-)
diff --git a/libstdc++-v3/include/bits/alloc_traits.h b/libstdc++-v3/include/bits/alloc_traits.h
index 988b2c47dc3..a81122e7a64 100644
--- a/libstdc++-v3/include/bits/alloc_traits.h
+++ b/libstdc++-v3/include/bits/alloc_traits.h
@@ -332,7 +332,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 40ef8758a51..cacc31a9aa9 100644
--- a/libstdc++-v3/include/bits/basic_string.h
+++ b/libstdc++-v3/include/bits/basic_string.h
@@ -4660,10 +4660,9 @@ _GLIBCXX_END_NAMESPACE_CXX11
/**
* @brief Insert a string_view.
- * @param __pos Iterator referencing position in string to insert at.
- * @param __svt The object convertible to string_view to insert from.
- * @param __pos Iterator referencing position in string_view to insert
- * from.
+ * @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 269ba7cfb77..a94457476ed 100644
--- a/libstdc++-v3/include/bits/regex.h
+++ b/libstdc++-v3/include/bits/regex.h
@@ -910,9 +910,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
@@ -920,13 +920,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 d9ac004434a..8356250034e 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 ab46b57fb15..6a9f28c9020 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
+ *
* @{
*/
@@ -152,6 +153,6 @@ namespace __gnu_pbds
swap(priority_queue& other)
{ base_type::swap(other); }
};
-} // namespace __gnu_pbds
///@} heap-based
+} // namespace __gnu_pbds
#endif
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2021-04-08 23:38 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-08 23:38 [gcc r9-9332] libstdc++: Fix Doxygen warnings 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).