aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Wakely <jwakely@redhat.com>2022-05-11 16:13:16 +0100
committerJonathan Wakely <jwakely@redhat.com>2022-05-13 13:32:22 +0100
commit757146fb1c82b49e78ee82c882677814f25c2429 (patch)
tree76017f4192667098f5e0e26f5170573de0309596
parente4905f11852d722cd711b53a5626245528ace1d2 (diff)
downloadgcc-757146fb1c82b49e78ee82c882677814f25c2429.zip
gcc-757146fb1c82b49e78ee82c882677814f25c2429.tar.gz
gcc-757146fb1c82b49e78ee82c882677814f25c2429.tar.bz2
libstdc++: Improve doxygen docs for std::pointer_traits
libstdc++-v3/ChangeLog: * include/bits/ptr_traits.h: Add some doxygen comments.
-rw-r--r--libstdc++-v3/include/bits/ptr_traits.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/libstdc++-v3/include/bits/ptr_traits.h b/libstdc++-v3/include/bits/ptr_traits.h
index 047efa5..8360c3b 100644
--- a/libstdc++-v3/include/bits/ptr_traits.h
+++ b/libstdc++-v3/include/bits/ptr_traits.h
@@ -47,6 +47,8 @@ namespace std _GLIBCXX_VISIBILITY(default)
{
_GLIBCXX_BEGIN_NAMESPACE_VERSION
+ /// @cond undocumented
+
class __undefined;
// For a specialization `SomeTemplate<T, Types...>` the member `type` is T,
@@ -91,6 +93,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
using __ptr_traits_elem_t = typename __ptr_traits_elem<_Ptr>::type;
#endif
+ /// @endcond
+
// Define pointer_traits<P>::pointer_to.
template<typename _Ptr, typename _Elt, bool = is_void<_Elt>::value>
struct __ptr_traits_ptr_to
@@ -187,6 +191,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
/**
* @brief Uniform interface to all pointer-like types
+ * @headerfile memory
* @ingroup pointer_abstractions
* @since C++11
*/
@@ -203,6 +208,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
/**
* @brief Partial specialization for built-in pointers.
+ * @headerfile memory
* @ingroup pointer_abstractions
* @since C++11
*/