From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 2181) id 1B5E338582BD; Mon, 18 Mar 2024 14:07:47 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 1B5E338582BD DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1710770867; bh=eseYvWakwWZQQZYuDPQS8VnmIwZronxLqvH4VaGnf3M=; h=From:To:Subject:Date:From; b=xXpmXXovel/PkpmEsTkLx9tAcMJ/GfFv8i/b7J86zPFt1FMrv6nn+o95eHnSO+nY3 b05pHACzblq1W7qc5/jzByGrhhEh110XZXwLf4WNOqb6Tt3Ie7OmLQAf5Isz8IxhCc 9mBsCbvChaoyS/IJKz824ljuUoStw//D8xQL1hO4= MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="utf-8" From: Jonathan Wakely To: gcc-cvs@gcc.gnu.org, libstdc++-cvs@gcc.gnu.org Subject: [gcc r12-10271] libstdc++: Improve doxygen docs for some of X-Act-Checkin: gcc X-Git-Author: Jonathan Wakely X-Git-Refname: refs/heads/releases/gcc-12 X-Git-Oldrev: 0d128f51e59c053be8da84c10acff722745862da X-Git-Newrev: 0a9cfae13f8873aa95dc143d653f834e6f9a3576 Message-Id: <20240318140747.1B5E338582BD@sourceware.org> Date: Mon, 18 Mar 2024 14:07:47 +0000 (GMT) List-Id: https://gcc.gnu.org/g:0a9cfae13f8873aa95dc143d653f834e6f9a3576 commit r12-10271-g0a9cfae13f8873aa95dc143d653f834e6f9a3576 Author: Jonathan Wakely Date: Thu May 12 23:04:29 2022 +0100 libstdc++: Improve doxygen docs for some of 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. (cherry picked from commit a278402216e75d5d54e62d2cd2345ea130349f10) Diff: --- libstdc++-v3/doc/doxygen/user.cfg.in | 1 + libstdc++-v3/include/backward/auto_ptr.h | 4 ++++ libstdc++-v3/include/bits/unique_ptr.h | 13 ++++++++++--- 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 ac83e084412..0f67da64a60 100644 --- a/libstdc++-v3/doc/doxygen/user.cfg.in +++ b/libstdc++-v3/doc/doxygen/user.cfg.in @@ -2389,6 +2389,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 8725504d4c9..184ab403466 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 class auto_ptr diff --git a/libstdc++-v3/include/bits/unique_ptr.h b/libstdc++-v3/include/bits/unique_ptr.h index ad60fada59b..e1ad7721a59 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 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` + /** Specialization of default_delete for arrays, used by `unique_ptr` + * + * @headerfile memory + * @since C++11 + */ template struct default_delete<_Tp[]> { diff --git a/libstdc++-v3/include/std/scoped_allocator b/libstdc++-v3/include/std/scoped_allocator index dd00e8efdbb..61619ebd3e2 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