From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 2181) id 59353384F6D7; Mon, 21 Nov 2022 18:51:01 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 59353384F6D7 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1669056661; bh=tjrdDPzDAsaRE2ZkRziDEyUymyHoKlskvpdELyTnMuA=; h=From:To:Subject:Date:From; b=TUQgMyIfMCloZtdEFMwtp/awap9y/4m/sucKZB5kZM8SuYha9AjzADb8WuulPNPz7 05HDx7l8ERau88ZnNVIzpDyzf+2QgLQZ1bKt/rzfZjumkND9MZdi1HR2B9Khu8ERXp ZC58tq1exwO+bJEkj8PdX5DGdXcL4sSQs4/Lzwhs= 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 r13-4212] libstdc++: Improve Doxygen comments in X-Act-Checkin: gcc X-Git-Author: Jonathan Wakely X-Git-Refname: refs/heads/master X-Git-Oldrev: 9fe9dd2455ecc2d02c50559eb272b480cafc8c68 X-Git-Newrev: 94f7baf2194e2d20108c9d34d2766e6b14e25cef Message-Id: <20221121185101.59353384F6D7@sourceware.org> Date: Mon, 21 Nov 2022 18:51:01 +0000 (GMT) List-Id: https://gcc.gnu.org/g:94f7baf2194e2d20108c9d34d2766e6b14e25cef commit r13-4212-g94f7baf2194e2d20108c9d34d2766e6b14e25cef Author: Jonathan Wakely Date: Mon Nov 21 14:12:52 2022 +0000 libstdc++: Improve Doxygen comments in libstdc++-v3/ChangeLog: * include/std/tuple: Add better Doxygen comments. Diff: --- libstdc++-v3/include/std/tuple | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/libstdc++-v3/include/std/tuple b/libstdc++-v3/include/std/tuple index 26e248431ec..0ac592d8d94 100644 --- a/libstdc++-v3/include/std/tuple +++ b/libstdc++-v3/include/std/tuple @@ -1980,6 +1980,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION #endif // three_way_comparison // NB: DR 705. + /// Create a tuple containing copies of the arguments template constexpr tuple::__type...> make_tuple(_Elements&&... __args) @@ -1991,7 +1992,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION // _GLIBCXX_RESOLVE_LIB_DEFECTS // 2275. Why is forward_as_tuple not constexpr? - /// std::forward_as_tuple + /// Create a tuple of lvalue or rvalue references to the arguments template constexpr tuple<_Elements&&...> forward_as_tuple(_Elements&&... __args) noexcept @@ -2018,7 +2019,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION constexpr const _Tp&& get(const array<_Tp, _Nm>&&) noexcept; - + /// @cond undocumented template struct __make_tuple_impl; @@ -2130,8 +2131,9 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION template struct __is_tuple_like_impl> : true_type { }; + /// @endcond - /// tuple_cat + /// Create a `tuple` containing all elements from multiple tuple-like objects template...>::value>::type> constexpr auto @@ -2146,13 +2148,13 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION // _GLIBCXX_RESOLVE_LIB_DEFECTS // 2301. Why is tie not constexpr? - /// tie + /// Return a tuple of lvalue references bound to the arguments template constexpr tuple<_Elements&...> tie(_Elements&... __args) noexcept { return tuple<_Elements&...>(__args...); } - /// swap + /// Exchange the values of two tuples template _GLIBCXX20_CONSTEXPR inline @@ -2177,6 +2179,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION #endif // C++23 #if __cplusplus > 201402L || !defined(__STRICT_ANSI__) // c++1z or gnu++11 + /// Exchange the values of two const tuples (if const elements can be swapped) template _GLIBCXX20_CONSTEXPR typename enable_if...>::value>::type @@ -2197,6 +2200,21 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION // _GLIBCXX_RESOLVE_LIB_DEFECTS // 2773. Making std::ignore constexpr + /** Used with `std::tie` to ignore an element of a tuple + * + * When using `std::tie` to assign the elements of a tuple to variables, + * unwanted elements can be ignored by using `std::ignore`. For example: + * + * ``` + * int x, y; + * std::tie(x, std::ignore, y) = std::make_tuple(1, 2, 3); + * ``` + * + * This assignment will perform `x=1; std::ignore=2; y=3;` which results + * in the second element being ignored. + * + * @since C++11 + */ _GLIBCXX17_INLINE constexpr _Swallow_assign ignore{}; /// Partial specialization for tuples