]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
libstdc++: Improve doxygen docs for some of <memory>
authorJonathan Wakely <jwakely@redhat.com>
Thu, 12 May 2022 22:04:29 +0000 (23:04 +0100)
committerJonathan Wakely <jwakely@redhat.com>
Fri, 13 May 2022 12:32:23 +0000 (13:32 +0100)
libstdc++-v3/ChangeLog:

* doc/doxygen/user.cfg.in (PREDEFINED): Define
_GLIBCXX23_CONSTEXPR macro.
* include/backward/auto_ptr.h (auto_ptr): Use @deprecated.
* include/bits/unique_ptr.h (default_delete): Use @since and
@headerfile.
* include/std/scoped_allocator: Remove @ingroup from @file
block.

libstdc++-v3/doc/doxygen/user.cfg.in
libstdc++-v3/include/backward/auto_ptr.h
libstdc++-v3/include/bits/unique_ptr.h
libstdc++-v3/include/std/scoped_allocator

index cfda7ab13c497c26fef5afb5a3958f11c2459f1b..4d21968cc57f5e5ead6e233474a343b3822df385 100644 (file)
@@ -2388,6 +2388,7 @@ PREDEFINED             = __cplusplus=202002L \
                          _GLIBCXX14_CONSTEXPR=constexpr \
                          _GLIBCXX17_CONSTEXPR=constexpr \
                          _GLIBCXX20_CONSTEXPR=constexpr \
+                         _GLIBCXX23_CONSTEXPR=constexpr \
                          "_GLIBCXX11_DEPRECATED= " \
                          "_GLIBCXX11_DEPRECATED_SUGGEST(E)= " \
                          "_GLIBCXX17_DEPRECATED= " \
index 8725504d4c92303fbe8e1782e10d393d760c7703..184ab4034660e40dbb568446a01f133e5c615ebe 100644 (file)
@@ -84,6 +84,10 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
    *  _GLIBCXX_RESOLVE_LIB_DEFECTS
    *  127.  auto_ptr<> conversion issues
    *  These resolutions have all been incorporated.
+   *
+   * @headerfile memory
+   * @deprecated Deprecated in C++11, no longer in the standard since C++17.
+   * Use `unique_ptr` instead.
    */
   template<typename _Tp>
     class auto_ptr
index ad60fada59bf491079b113f4b904ef13880bea89..e1ad7721a5935828783b54154f58d80c75662bc8 100644 (file)
@@ -65,8 +65,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
 #pragma GCC diagnostic pop
 #endif
 
-  /// Primary template of default_delete, used by unique_ptr for single objects
-  /// @since C++11
+  /** Primary template of default_delete, used by unique_ptr for single objects
+   *
+   * @headerfile memory
+   * @since C++11
+   */
   template<typename _Tp>
     struct default_delete
     {
@@ -99,7 +102,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
   // _GLIBCXX_RESOLVE_LIB_DEFECTS
   // DR 740 - omit specialization for array objects with a compile time length
 
-  /// Specialization of default_delete for arrays, used by `unique_ptr<T[]>`
+  /** Specialization of default_delete for arrays, used by `unique_ptr<T[]>`
+   *
+   * @headerfile memory
+   * @since C++11
+   */
   template<typename _Tp>
     struct default_delete<_Tp[]>
     {
index f2e3ed9f7833b80a72e0c0c6761dfece62baaf22..c62b04874e23ded746ad8617712fc9db4d1dffc1 100644 (file)
@@ -24,7 +24,6 @@
 
 /** @file include/scoped_allocator
  *  This is a Standard C++ Library header.
- *  @ingroup allocators
  */
 
 #ifndef _SCOPED_ALLOCATOR