]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
libstdc++: Minor fixes to doxygen comments
authorJonathan Wakely <jwakely@redhat.com>
Fri, 28 Apr 2023 10:40:01 +0000 (11:40 +0100)
committerJonathan Wakely <jwakely@redhat.com>
Fri, 28 Apr 2023 12:05:51 +0000 (13:05 +0100)
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.

libstdc++-v3/include/bits/regex.tcc
libstdc++-v3/include/bits/uses_allocator.h
libstdc++-v3/include/experimental/memory_resource
libstdc++-v3/include/std/bit
libstdc++-v3/include/std/expected
libstdc++-v3/include/std/numbers

index a58ed3f555fa57f4bff7d50ce8a0b9b8f1c986a2..6f0a486eb04a7c58d27682f4656c6700af7c36f2 100644 (file)
@@ -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
index d1841bbee5d52c46157db06ccf75f87e46f396f2..d3b26c7d9745a2e0b2b9460ef755dc822acc53c2 100644 (file)
 // 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
 
index 070cf791c65b36a2289dbb4ea3ee511a7a076c3d..9f1cb42373eda34a1b1dd12c1828425315a4123d 100644 (file)
 #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
index 0c58971bd5969616df4c3947a223abe05469c57c..5eb40218be9d5344e3ee4685e5ffb34652188b64 100644 (file)
@@ -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>;
index 058188248bb48e22f6a45db9232492d74b16cc8e..c6d26b0d224e1cd16b1b8ddd895607cbf35c8f6d 100644 (file)
@@ -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>
index d9d202f53926dbce49ae17f45c158afef2c7db4e..d7d9e81e540330e9ce3ce70d499e0abb3ced51e6 100644 (file)
@@ -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