From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by sourceware.org (Postfix) with ESMTPS id AC88A3858416 for ; Thu, 21 Oct 2021 21:56:24 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org AC88A3858416 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-323-Rjc5xexpP4CVy8wPsjbqBQ-1; Thu, 21 Oct 2021 17:56:22 -0400 X-MC-Unique: Rjc5xexpP4CVy8wPsjbqBQ-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C209510A8E01; Thu, 21 Oct 2021 21:56:21 +0000 (UTC) Received: from localhost (unknown [10.33.36.194]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3E1365D9DE; Thu, 21 Oct 2021 21:56:21 +0000 (UTC) From: Jonathan Wakely To: patches@gcc.gnu.org, libstdc++@gcc.gnu.org Subject: [committed] libstdc++: Suppress Doxygen docs for more implementation details Date: Thu, 21 Oct 2021 22:56:20 +0100 Message-Id: <20211021215620.820918-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" X-Spam-Status: No, score=-13.8 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: libstdc++@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libstdc++ mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 Oct 2021 21:56:26 -0000 Tested x86_64-linux, committed to trunk. libstdc++-v3/ChangeLog: * include/bits/alloc_traits.h: Suppress doxygen documentation. * include/bits/allocated_ptr.h: Likewise. * include/bits/enable_special_members.h: Likewise. * include/bits/hashtable.h: Likewise. * include/bits/hashtable_policy.h: Likewise. * include/bits/uses_allocator.h: Likewise. * include/bits/node_handle.h: Document node handles and suppress documentation for protected members. * include/std/any: Suppress documentation for implementation details. --- libstdc++-v3/include/bits/alloc_traits.h | 4 ++++ libstdc++-v3/include/bits/allocated_ptr.h | 2 ++ .../include/bits/enable_special_members.h | 2 ++ libstdc++-v3/include/bits/hashtable.h | 2 ++ libstdc++-v3/include/bits/hashtable_policy.h | 2 ++ libstdc++-v3/include/bits/node_handle.h | 20 +++++++++++++++++++ libstdc++-v3/include/bits/uses_allocator.h | 2 ++ libstdc++-v3/include/std/any | 8 +++++++- 8 files changed, 41 insertions(+), 1 deletion(-) diff --git a/libstdc++-v3/include/bits/alloc_traits.h b/libstdc++-v3/include/bits/alloc_traits.h index 05b584f742f..602a90d4d8a 100644 --- a/libstdc++-v3/include/bits/alloc_traits.h +++ b/libstdc++-v3/include/bits/alloc_traits.h @@ -45,6 +45,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION #if __cplusplus >= 201103L #define __cpp_lib_allocator_traits_is_always_equal 201411 + /// @cond undocumented struct __allocator_traits_base { template @@ -77,10 +78,13 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION template using __alloc_rebind = typename __allocator_traits_base::template __rebind<_Alloc, _Up>::type; + /// @endcond /** * @brief Uniform interface to all allocator types. + * @headerfile memory * @ingroup allocators + * @since C++11 */ template struct allocator_traits : __allocator_traits_base diff --git a/libstdc++-v3/include/bits/allocated_ptr.h b/libstdc++-v3/include/bits/allocated_ptr.h index 340964eed15..695695f7d11 100644 --- a/libstdc++-v3/include/bits/allocated_ptr.h +++ b/libstdc++-v3/include/bits/allocated_ptr.h @@ -40,6 +40,7 @@ namespace std _GLIBCXX_VISIBILITY(default) { _GLIBCXX_BEGIN_NAMESPACE_VERSION +/// @cond undocumented /// Non-standard RAII type for managing pointers obtained from allocators. template @@ -97,6 +98,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION return { __a, std::allocator_traits<_Alloc>::allocate(__a, 1) }; } +/// @endcond _GLIBCXX_END_NAMESPACE_VERSION } // namespace std diff --git a/libstdc++-v3/include/bits/enable_special_members.h b/libstdc++-v3/include/bits/enable_special_members.h index 8361a063b4d..ac59f72e328 100644 --- a/libstdc++-v3/include/bits/enable_special_members.h +++ b/libstdc++-v3/include/bits/enable_special_members.h @@ -37,6 +37,7 @@ namespace std _GLIBCXX_VISIBILITY(default) { _GLIBCXX_BEGIN_NAMESPACE_VERSION +/// @cond undocumented struct _Enable_default_constructor_tag { @@ -308,6 +309,7 @@ template operator=(_Enable_copy_move&&) noexcept = delete; }; +/// @endcond _GLIBCXX_END_NAMESPACE_VERSION } // namespace std diff --git a/libstdc++-v3/include/bits/hashtable.h b/libstdc++-v3/include/bits/hashtable.h index ff8af2201cd..25c45d3ba85 100644 --- a/libstdc++-v3/include/bits/hashtable.h +++ b/libstdc++-v3/include/bits/hashtable.h @@ -41,6 +41,7 @@ namespace std _GLIBCXX_VISIBILITY(default) { _GLIBCXX_BEGIN_NAMESPACE_VERSION +/// @cond undocumented template using __cache_default @@ -2546,6 +2547,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION = __enable_if_t, __is_allocator<_Hash>>::value>; #endif +/// @endcond _GLIBCXX_END_NAMESPACE_VERSION } // namespace std diff --git a/libstdc++-v3/include/bits/hashtable_policy.h b/libstdc++-v3/include/bits/hashtable_policy.h index 994c7b61046..8c72043e368 100644 --- a/libstdc++-v3/include/bits/hashtable_policy.h +++ b/libstdc++-v3/include/bits/hashtable_policy.h @@ -38,6 +38,7 @@ namespace std _GLIBCXX_VISIBILITY(default) { _GLIBCXX_BEGIN_NAMESPACE_VERSION +/// @cond undocumented template` type. You should always use the container's + * `node_handle` type (e.g. `std::set::node_handle`) to refer to + * these types, not the non-standard internal `_Node_handle` names. + * + * @{ + */ + /// Base class for node handle types of maps and sets. template class _Node_handle_common @@ -64,6 +79,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION [[nodiscard]] bool empty() const noexcept { return _M_ptr == nullptr; } + /// @cond undocumented protected: constexpr _Node_handle_common() noexcept : _M_ptr() { } @@ -214,6 +230,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION template friend class _Rb_tree; + + /// @endcond }; /// Node handle type for maps. @@ -367,6 +385,8 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION _NodeHandle node; }; + /// @} + _GLIBCXX_END_NAMESPACE_VERSION } // namespace std diff --git a/libstdc++-v3/include/bits/uses_allocator.h b/libstdc++-v3/include/bits/uses_allocator.h index 358c5713da5..bd4467094a2 100644 --- a/libstdc++-v3/include/bits/uses_allocator.h +++ b/libstdc++-v3/include/bits/uses_allocator.h @@ -35,6 +35,7 @@ namespace std _GLIBCXX_VISIBILITY(default) { _GLIBCXX_BEGIN_NAMESPACE_VERSION +/// @cond undocumented // This is used for std::experimental::erased_type from Library Fundamentals. struct __erased_type { }; @@ -188,6 +189,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION std::forward<_Args>(__args)...); } +/// @endcond _GLIBCXX_END_NAMESPACE_VERSION } // namespace std diff --git a/libstdc++-v3/include/std/any b/libstdc++-v3/include/std/any index e3d9d774de4..9c102a58b26 100644 --- a/libstdc++-v3/include/std/any +++ b/libstdc++-v3/include/std/any @@ -72,8 +72,10 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION /** * @brief A type-safe container of any type. * - * An @c any object's state is either empty or it stores a contained object + * An `any` object's state is either empty or it stores a contained object * of CopyConstructible type. + * + * @since C++17 */ class any { @@ -337,9 +339,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION } #endif + /// @cond undocumented template static constexpr bool __is_valid_cast() { return __or_, is_copy_constructible<_Tp>>::value; } + /// @endcond private: enum _Op { @@ -356,8 +360,10 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION void (*_M_manager)(_Op, const any*, _Arg*); _Storage _M_storage; + /// @cond undocumented template friend void* __any_caster(const any* __any); + /// @endcond // Manage in-place contained object. template -- 2.31.1