From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mout-p-101.mailbox.org (mout-p-101.mailbox.org [IPv6:2001:67c:2050:0:465::101]) by sourceware.org (Postfix) with ESMTPS id D88CA3858D38; Sat, 1 Oct 2022 18:43:07 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org D88CA3858D38 Authentication-Results: sourceware.org; dmarc=pass (p=reject dis=none) header.from=aarsen.me Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=aarsen.me Received: from smtp1.mailbox.org (smtp1.mailbox.org [10.196.197.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-101.mailbox.org (Postfix) with ESMTPS id 4Mfwvr4mttz9sSb; Sat, 1 Oct 2022 20:43:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aarsen.me; s=MBO0001; t=1664649784; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=i5AkYSn9YgM2/0yoPr9ueug488ZWc2OIED7D/Xarp40=; b=0BiIym60SPcH0XCj10YK3dmn+RdrzKXQttztVXpK0xyPCXaUIy+pT6WtZaLz6Q0mAznzR9 ezFKK+Lkf2UtIlwC8vORn+LibSU35ZFfX5mwc2HvRPgkf8+Yieh4llMOIJnW//McTFZ/Mz 2HzzwObZdiK+e4quP2ezpwFT4ACgTSesG5D3Q5FawwwFhreiI2k3rDdd8f3mc4AksuaJeb AX+ArUa62G+BLwhuMiD8u60G7lZUg6L0CcB4jaT97aJnVzeeUIpF35u3OcdNS76kofxFAG 1RyRAul7k1wX62Zv52fpvtLskLOOpXQNMGKDGiIUegkOt/55Oi9c9QEbjQvMzA== From: =?UTF-8?q?Arsen=20Arsenovi=C4=87?= To: gcc-patches@gcc.gnu.org Cc: libstdc++@gcc.gnu.org, =?UTF-8?q?Arsen=20Arsenovi=C4=87?= Subject: [PATCH] libstdc++: Use ///< for inline documentation Date: Sat, 1 Oct 2022 20:40:05 +0200 Message-Id: <20221001184004.3599748-1-arsen@aarsen.me> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-11.4 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,GIT_PATCH_0,KAM_INFOUSMEBIZ,RCVD_IN_DNSWL_LOW,SPF_HELO_NONE,SPF_PASS,TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: I accidentally 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. Signed-off-by: Arsen Arsenović --- Hey, I just got reminded that I found some trivial documentation errors a few months ago, and forgot to do anything about them after bringing them up on IRC. This patch should fix that. Thanks, 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 4be4bfb731e..a6b7b235087 100644 --- a/libstdc++-v3/include/experimental/internet +++ b/libstdc++-v3/include/experimental/internet @@ -2137,7 +2137,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 d705913f53c..83a238193ce 100644 --- a/libstdc++-v3/include/std/iostream +++ b/libstdc++-v3/include/std/iostream @@ -57,16 +57,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. }; /** -- 2.37.3