From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 2181) id 2307E3858D1E; Tue, 4 Oct 2022 09:32:30 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 2307E3858D1E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1664875950; bh=KJybRT/lZ297uuYBwjHCcsa0LexdEa0Xjfvls0EeOOw=; h=From:To:Subject:Date:From; b=MY6I1oKB6FdD7a1spvJptgAXQtReT/lDNPMCq46eWZkDtuz0Xqoe0YCOB2kCp77mf 6n5NvMKK6u98B24KWRP3PUt1gzj5/fuyJRRYlg2VxKj2a+4iZFblFzUGeZxxbgZTIc jrxN/69RoQFC9Fb7plEs4PiDHb+ZcGgQrdxgTgLo= MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="utf-8" From: Jonathan Wakely To: gcc-cvs@gcc.gnu.org, libstdc++-cvs@gcc.gnu.org Subject: [gcc r13-3055] libstdc++: Use ///< for inline documentation X-Act-Checkin: gcc X-Git-Author: =?utf-8?q?Arsen_Arsenovi=C4=87?= X-Git-Refname: refs/heads/master X-Git-Oldrev: b6d5d72bd0b71ac96a8b2ee537367c46107dcb73 X-Git-Newrev: 49c3e9dfc5e23a335f4057efffbff2273e3c4631 Message-Id: <20221004093230.2307E3858D1E@sourceware.org> Date: Tue, 4 Oct 2022 09:32:30 +0000 (GMT) List-Id: https://gcc.gnu.org/g:49c3e9dfc5e23a335f4057efffbff2273e3c4631 commit r13-3055-g49c3e9dfc5e23a335f4057efffbff2273e3c4631 Author: Arsen Arsenović Date: Sat Oct 1 20:40:05 2022 +0200 libstdc++: Use ///< for inline documentation I noticed that some variables were misdocumented when using trailing comment for documentation. I ran a search with a relatively simple regex[1] to look for any ///s following some code that did not have a <, and came up with these instances only. [1]: \s*([^ ]+\s*)+///[^<].*$ libstdc++-v3/ChangeLog: * include/std/iostream: Use ///< for inline documentation. * include/std/limits: Likewise. * include/experimental/internet: Likewise. Diff: --- libstdc++-v3/include/experimental/internet | 2 +- libstdc++-v3/include/std/iostream | 16 ++++++++-------- libstdc++-v3/include/std/limits | 10 +++++----- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/libstdc++-v3/include/experimental/internet b/libstdc++-v3/include/experimental/internet index 6e3c355f38e..691198994e9 100644 --- a/libstdc++-v3/include/experimental/internet +++ b/libstdc++-v3/include/experimental/internet @@ -2139,7 +2139,7 @@ namespace ip using resolver = basic_resolver; ///< A TCP resolver. using socket = basic_stream_socket; ///< A TCP socket. using acceptor = basic_socket_acceptor; ///< A TCP acceptor. - using iostream = basic_socket_iostream; /// A TCP iostream. + using iostream = basic_socket_iostream; ///< A TCP iostream. #ifdef TCP_NODELAY /// Disable coalescing of small segments (i.e. the Nagle algorithm). diff --git a/libstdc++-v3/include/std/iostream b/libstdc++-v3/include/std/iostream index 685d29a32f4..02e9c3039d1 100644 --- a/libstdc++-v3/include/std/iostream +++ b/libstdc++-v3/include/std/iostream @@ -59,16 +59,16 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION * manual linked to above. */ ///@{ - extern istream cin; /// Linked to standard input - extern ostream cout; /// Linked to standard output - extern ostream cerr; /// Linked to standard error (unbuffered) - extern ostream clog; /// Linked to standard error (buffered) + extern istream cin; ///< Linked to standard input + extern ostream cout; ///< Linked to standard output + extern ostream cerr; ///< Linked to standard error (unbuffered) + extern ostream clog; ///< Linked to standard error (buffered) #ifdef _GLIBCXX_USE_WCHAR_T - extern wistream wcin; /// Linked to standard input - extern wostream wcout; /// Linked to standard output - extern wostream wcerr; /// Linked to standard error (unbuffered) - extern wostream wclog; /// Linked to standard error (buffered) + extern wistream wcin; ///< Linked to standard input + extern wostream wcout; ///< Linked to standard output + extern wostream wcerr; ///< Linked to standard error (unbuffered) + extern wostream wclog; ///< Linked to standard error (buffered) #endif ///@} diff --git a/libstdc++-v3/include/std/limits b/libstdc++-v3/include/std/limits index 66201fa6215..a60611b1b11 100644 --- a/libstdc++-v3/include/std/limits +++ b/libstdc++-v3/include/std/limits @@ -166,11 +166,11 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION */ enum float_round_style { - round_indeterminate = -1, /// Intermediate. - round_toward_zero = 0, /// To zero. - round_to_nearest = 1, /// To the nearest representable value. - round_toward_infinity = 2, /// To infinity. - round_toward_neg_infinity = 3 /// To negative infinity. + round_indeterminate = -1, ///< Intermediate. + round_toward_zero = 0, ///< To zero. + round_to_nearest = 1, ///< To the nearest representable value. + round_toward_infinity = 2, ///< To infinity. + round_toward_neg_infinity = 3 ///< To negative infinity. }; /**