[committed,11/12] libstdc++: Improve doxygen docs for some of <memory>
Commit Message
Tested powerpc64le-linux, pushed to trunk.
-- >8 --
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 | 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(-)
@@ -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= " \
@@ -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
@@ -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[]>
{
@@ -24,7 +24,6 @@
/** @file include/scoped_allocator
* This is a Standard C++ Library header.
- * @ingroup allocators
*/
#ifndef _SCOPED_ALLOCATOR