diff options
| author | Jonathan Wakely <jwakely@redhat.com> | 2022-05-12 23:04:29 +0100 |
|---|---|---|
| committer | Jonathan Wakely <jwakely@redhat.com> | 2022-05-13 13:32:23 +0100 |
| commit | a278402216e75d5d54e62d2cd2345ea130349f10 (patch) | |
| tree | f2559dbac49d0327b58eb691a5fe8352dae32684 | |
| parent | c29c2a0604719684ca3d65c7c10912c11afb8357 (diff) | |
| download | gcc-a278402216e75d5d54e62d2cd2345ea130349f10.zip gcc-a278402216e75d5d54e62d2cd2345ea130349f10.tar.gz gcc-a278402216e75d5d54e62d2cd2345ea130349f10.tar.bz2 | |
libstdc++: Improve doxygen docs for some of <memory>
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.
| -rw-r--r-- | libstdc++-v3/doc/doxygen/user.cfg.in | 1 | ||||
| -rw-r--r-- | libstdc++-v3/include/backward/auto_ptr.h | 4 | ||||
| -rw-r--r-- | libstdc++-v3/include/bits/unique_ptr.h | 13 | ||||
| -rw-r--r-- | libstdc++-v3/include/std/scoped_allocator | 1 |
4 files changed, 15 insertions, 4 deletions
diff --git a/libstdc++-v3/doc/doxygen/user.cfg.in b/libstdc++-v3/doc/doxygen/user.cfg.in index cfda7ab..4d21968 100644 --- a/libstdc++-v3/doc/doxygen/user.cfg.in +++ b/libstdc++-v3/doc/doxygen/user.cfg.in @@ -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= " \ diff --git a/libstdc++-v3/include/backward/auto_ptr.h b/libstdc++-v3/include/backward/auto_ptr.h index 8725504..184ab40 100644 --- a/libstdc++-v3/include/backward/auto_ptr.h +++ b/libstdc++-v3/include/backward/auto_ptr.h @@ -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 diff --git a/libstdc++-v3/include/bits/unique_ptr.h b/libstdc++-v3/include/bits/unique_ptr.h index ad60fad..e1ad772 100644 --- a/libstdc++-v3/include/bits/unique_ptr.h +++ b/libstdc++-v3/include/bits/unique_ptr.h @@ -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[]> { diff --git a/libstdc++-v3/include/std/scoped_allocator b/libstdc++-v3/include/std/scoped_allocator index f2e3ed9..c62b048 100644 --- a/libstdc++-v3/include/std/scoped_allocator +++ b/libstdc++-v3/include/std/scoped_allocator @@ -24,7 +24,6 @@ /** @file include/scoped_allocator * This is a Standard C++ Library header. - * @ingroup allocators */ #ifndef _SCOPED_ALLOCATOR |