From patchwork Sat Oct 1 18:40:05 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Arsen_Arsenovi=C4=87?= X-Patchwork-Id: 1630 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp339933wrs; Sat, 1 Oct 2022 11:43:59 -0700 (PDT) X-Google-Smtp-Source: AMsMyM6ZdKAnhv8UaWSLfkkNtU7vxneiTyn/1//g/0TfJvN5moAICKXlsnGYn7T+JPql8L1z+hJ3 X-Received: by 2002:a17:906:4795:b0:787:434f:d754 with SMTP id cw21-20020a170906479500b00787434fd754mr10927249ejc.268.1664649839638; Sat, 01 Oct 2022 11:43:59 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664649839; cv=none; d=google.com; s=arc-20160816; b=CiETsf6vWwDxUvVkEsfIL7Cby9IfawZTftJ2cQeLRFS9FcL56pbLIxRWydQQSyBcnC QHdyYLQbCrQHOPS4YKZAmOZahnkCb/SOprFBNrbow29wpJmvIHeK31iTR/2yAPPBQj2z jDRFFVUBObFaQMYzIGteg4pZHDAWeNFlSz15rkN7rPqYOqME0qMl/Cj3MNLDmBoB3Bny Ed6nFYlMQwwYDcBBS5jqgCv3UkoV08Ehq0F5NTtOvYYMNsM1AhZRJFgJcW0DlHBFY36X VX4LSee93Aut9bO1HdVDNGWw3uR8gvVNr/bmVG8nBWIt+ShAEMx5FBHH1nVb4Joo9S1/ ZVmw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:reply-to:from:list-subscribe:list-help :list-post:list-archive:list-unsubscribe:list-id:precedence :content-transfer-encoding:mime-version:message-id:date:subject:to :dmarc-filter:delivered-to:dkim-signature:dkim-filter; bh=i5AkYSn9YgM2/0yoPr9ueug488ZWc2OIED7D/Xarp40=; b=FB5LnTOmW3k1n+nHZHD2JeQzfMiGF6S738IdHX9kjBaI+StrcpY4nIzH1FnMQFnMqB MKf2VVBZCE/BuCeV+6VJ7vAsJyt1VGSel2/+9JDZhf2WeoxT2jM2xUx6Yd4z4fZf4Rcv a/HH3ermA/GWtS871fUGmDHiUxy3MWdwIYWT9Qhfw0f94h5GM1EgyqGEwpcW2ZQQE3Wa 0aBZdekQxdml/H1+tUhqYySX6rLo7zAUbyiST0GJLyKVxnl3UlZYSnMyBzojSAsiGcc7 V3YE6Yp8ergSnrn9vIP9K//CkfJCsB0WZ18wVvDTLA9/0fZ0/e6U7ExhO4S+JrRXXmig zkMQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=u0UIXi0G; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from sourceware.org (ip-8-43-85-97.sourceware.org. [8.43.85.97]) by mx.google.com with ESMTPS id hz6-20020a1709072ce600b00783a5f78700si4865580ejc.226.2022.10.01.11.43.59 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 01 Oct 2022 11:43:59 -0700 (PDT) Received-SPF: pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) client-ip=8.43.85.97; Authentication-Results: mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=u0UIXi0G; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 65A42385AC32 for ; Sat, 1 Oct 2022 18:43:54 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 65A42385AC32 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1664649834; bh=i5AkYSn9YgM2/0yoPr9ueug488ZWc2OIED7D/Xarp40=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:Cc:From; b=u0UIXi0GGf2LOikDsa/C6ZKisYNwQyFbOEsWHg4Rx/snvbuFve/TUjGHkA7YFb6Dh ltkbq668bXcZ0YIEULnbbMmDWhF4du8G3onUid4DPaW9rzwrhVuyNkTbBCIjWMZzml yLNeIvMHF2ilrLvTfuahePZrSI6p0ttThrbamzw4= X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org 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 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) To: gcc-patches@gcc.gnu.org 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 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 X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: =?utf-8?q?Arsen_Arsenovi=C4=87_via_Gcc-patches?= From: =?utf-8?q?Arsen_Arsenovi=C4=87?= Reply-To: =?utf-8?q?Arsen_Arsenovi=C4=87?= Cc: libstdc++@gcc.gnu.org Errors-To: gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org Sender: "Gcc-patches" X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1745511870501746860?= X-GMAIL-MSGID: =?utf-8?q?1745511870501746860?= 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. }; /**