public inbox for gcc-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 r14-329] libstdc++: Minor fixes to doxygen comments
Date: Fri, 28 Apr 2023 12:07:33 +0000 (GMT)	[thread overview]
Message-ID: <20230428120733.6FAF73858C31@sourceware.org> (raw)

https://gcc.gnu.org/g:30f6aace7fe5c535af41a1f08ab00dc14fedf02d

commit r14-329-g30f6aace7fe5c535af41a1f08ab00dc14fedf02d
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Fri Apr 28 11:40:01 2023 +0100

    libstdc++: Minor fixes to doxygen comments
    
    libstdc++-v3/ChangeLog:
    
            * include/bits/uses_allocator.h: Add missing @file comment.
            * include/bits/regex.tcc: Remove stray doxygen comments.
            * include/experimental/memory_resource: Likewise.
            * include/std/bit: Tweak doxygen @cond comments.
            * include/std/expected: Likewise.
            * include/std/numbers: Likewise.

Diff:
---
 libstdc++-v3/include/bits/regex.tcc               | 4 ----
 libstdc++-v3/include/bits/uses_allocator.h        | 5 +++++
 libstdc++-v3/include/experimental/memory_resource | 2 --
 libstdc++-v3/include/std/bit                      | 4 ++--
 libstdc++-v3/include/std/expected                 | 4 ++--
 libstdc++-v3/include/std/numbers                  | 2 +-
 6 files changed, 10 insertions(+), 11 deletions(-)

diff --git a/libstdc++-v3/include/bits/regex.tcc b/libstdc++-v3/include/bits/regex.tcc
index a58ed3f555f..6f0a486eb04 100644
--- a/libstdc++-v3/include/bits/regex.tcc
+++ b/libstdc++-v3/include/bits/regex.tcc
@@ -116,8 +116,6 @@ namespace __detail
   /// @endcond
 } // namespace __detail
 
-  /// @cond
-
   template<typename _Ch_type>
   template<typename _Fwd_iter>
     typename regex_traits<_Ch_type>::string_type
@@ -665,7 +663,5 @@ namespace __detail
 	_M_result = nullptr;
     }
 
-  /// @endcond
-
 _GLIBCXX_END_NAMESPACE_VERSION
 } // namespace
diff --git a/libstdc++-v3/include/bits/uses_allocator.h b/libstdc++-v3/include/bits/uses_allocator.h
index d1841bbee5d..d3b26c7d974 100644
--- a/libstdc++-v3/include/bits/uses_allocator.h
+++ b/libstdc++-v3/include/bits/uses_allocator.h
@@ -22,6 +22,11 @@
 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 // <http://www.gnu.org/licenses/>.
 
+/** @file include/bits/uses_allocator_args.h
+ *  This is an internal header file, included by other library headers.
+ *  Do not attempt to use it directly. @headername{memory}
+ */
+
 #ifndef _USES_ALLOCATOR_H
 #define _USES_ALLOCATOR_H 1
 
diff --git a/libstdc++-v3/include/experimental/memory_resource b/libstdc++-v3/include/experimental/memory_resource
index 070cf791c65..9f1cb42373e 100644
--- a/libstdc++-v3/include/experimental/memory_resource
+++ b/libstdc++-v3/include/experimental/memory_resource
@@ -45,14 +45,12 @@
 #include <bits/new_allocator.h>
 #include <debug/assertions.h>
 
-/// @cond
 namespace __gnu_cxx _GLIBCXX_VISIBILITY(default)
 {
 _GLIBCXX_BEGIN_NAMESPACE_VERSION
   template<typename _Tp> class malloc_allocator;
 _GLIBCXX_END_NAMESPACE_VERSION
 } // namespace __gnu_cxx
-/// @endcond
 
 namespace std {
 _GLIBCXX_BEGIN_NAMESPACE_VERSION
diff --git a/libstdc++-v3/include/std/bit b/libstdc++-v3/include/std/bit
index 0c58971bd59..5eb40218be9 100644
--- a/libstdc++-v3/include/std/bit
+++ b/libstdc++-v3/include/std/bit
@@ -144,7 +144,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
     }
 #endif
 
-  /// @cond undoc
+  /// @cond undocumented
 
   template<typename _Tp>
     constexpr _Tp
@@ -374,7 +374,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
 #define __cpp_lib_bitops 201907L
 
-  /// @cond undoc
+  /// @cond undocumented
   template<typename _Tp, typename _Up = _Tp>
     using _If_is_unsigned_integer
       = enable_if_t<__is_unsigned_integer<_Tp>::value, _Up>;
diff --git a/libstdc++-v3/include/std/expected b/libstdc++-v3/include/std/expected
index 058188248bb..c6d26b0d224 100644
--- a/libstdc++-v3/include/std/expected
+++ b/libstdc++-v3/include/std/expected
@@ -139,7 +139,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
    */
   inline constexpr unexpect_t unexpect{};
 
-/// @cond undoc
+/// @cond undocumented
 namespace __expected
 {
   template<typename _Tp>
@@ -254,7 +254,7 @@ namespace __expected
 
   template<typename _Er> unexpected(_Er) -> unexpected<_Er>;
 
-/// @cond undoc
+/// @cond undocumented
 namespace __expected
 {
   template<typename _Tp>
diff --git a/libstdc++-v3/include/std/numbers b/libstdc++-v3/include/std/numbers
index d9d202f5392..d7d9e81e540 100644
--- a/libstdc++-v3/include/std/numbers
+++ b/libstdc++-v3/include/std/numbers
@@ -49,7 +49,7 @@ namespace numbers
 {
 #define __cpp_lib_math_constants 201907L
 
-  /// @cond undoc
+  /// @cond undocumented
   template<typename _Tp>
     using _Enable_if_floating = enable_if_t<is_floating_point_v<_Tp>, _Tp>;
   /// @endcond

                 reply	other threads:[~2023-04-28 12:07 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=20230428120733.6FAF73858C31@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: 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).