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 [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 1CE063856DC6 for ; Mon, 3 Oct 2022 08:37:15 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 1CE063856DC6 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1664786234; 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: in-reply-to:in-reply-to:references:references; bh=kgS8EOTbxcKf6xkQ3eKZsxk2VENHa0JwEvEd4c5Ytx4=; b=LrFNsLpqRpd9lg7kdZlxMGrDYbeHat0Fv73NXNoLnaNN4bFlRclfLr9KJYp7TYXBrqSHAT cIdpmDYIGx9l03BlaREg/d+XxiQp586Bf79nU7GUt29EaSNuW3Mtdyj+wUg2baHAGSOaeU AOmUJW/T9lsyLSF4uksmiDE7b56UEuc= Received: from mail-qt1-f200.google.com (mail-qt1-f200.google.com [209.85.160.200]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_128_GCM_SHA256) id us-mta-354-svajcHbrPOqDg3syHAg3rw-1; Mon, 03 Oct 2022 04:37:11 -0400 X-MC-Unique: svajcHbrPOqDg3syHAg3rw-1 Received: by mail-qt1-f200.google.com with SMTP id bn4-20020a05622a1dc400b0035d24923a7fso6822687qtb.0 for ; Mon, 03 Oct 2022 01:37:11 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date; bh=kgS8EOTbxcKf6xkQ3eKZsxk2VENHa0JwEvEd4c5Ytx4=; b=76hxXDvWuQ/m8EuQIYG6FL3l4WsPRSIvU02M1atwWXW/tXVFahVSI5VTLAC+NhvQbo SUC2RGb9AS+9/DQ1PYBFz7PS+BdILitAOzGARnOwXW7gyrZ2J9xuNd4JACAJWHS7BlWp /LiMQG4auBWe0RSWAGrtRY3ShajdIBYDPv02R4dBXNtPmen6+5EF8OjcwsZYAe6rc0Ol 5Gmrg6DhvsoowtCQXeC5apHdSYC7p8pcqenLVsx57nKkj95a3WI32JaNPj2xQ51DN1u6 u+SiP0RbijcGOoyR5XPBBVAESDwZY+Fg2s6trtdME5IoXPYm1xK1aYjomEDbI+OGLUj5 3MUA== X-Gm-Message-State: ACrzQf0qvvvFR2LdOnLLTpSWbzO9nsFktSqBJLrfXdpjxca/tcYm/Eqt Hmi/r+FSpdn2CzluY1txvJHBnqpBrt/JR40f/SlifrKYJl7bNncrm/6PlebPxkVbp+2qS0gMjlQ v/rrDeKYD0Oc18QDvs2W/Rg5emhloN5E= X-Received: by 2002:a05:6214:20e2:b0:4ac:b800:d280 with SMTP id 2-20020a05621420e200b004acb800d280mr15335510qvk.52.1664786231355; Mon, 03 Oct 2022 01:37:11 -0700 (PDT) X-Google-Smtp-Source: AMsMyM5TCRYfeuIi2i8SwmEhG3w6ZlMay7S+m0FoOTY+2kTcB9WIdlnEHyWrLCFOCYQHJVrknrgFE+Eqt/HSA3VG7Po= X-Received: by 2002:a05:6214:20e2:b0:4ac:b800:d280 with SMTP id 2-20020a05621420e200b004acb800d280mr15335497qvk.52.1664786231092; Mon, 03 Oct 2022 01:37:11 -0700 (PDT) MIME-Version: 1.0 References: <20221001184004.3599748-1-arsen@aarsen.me> In-Reply-To: <20221001184004.3599748-1-arsen@aarsen.me> From: Jonathan Wakely Date: Mon, 3 Oct 2022 09:37:00 +0100 Message-ID: Subject: Re: [PATCH] libstdc++: Use ///< for inline documentation To: =?UTF-8?Q?Arsen_Arsenovi=C4=87?= Cc: gcc-patches@gcc.gnu.org, libstdc++@gcc.gnu.org X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=-12.2 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_NONE,SPF_HELO_NONE,SPF_NONE,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: On Sat, 1 Oct 2022 at 19:43, Arsen Arsenovi=C4=87 via Libstdc++ wrote: > > 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=C4=87 > --- > 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. I did look into this after you pointed it out on IRC. Unless I fumbled my doxygen roll, the results are the same for /// and ///< so maybe at some point Doxygen started to DTRT even without the < character. > > 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/in= clude/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 =3D basic_resolver; ///< A TCP resolver. > using socket =3D basic_stream_socket; ///< A TCP socket. > using acceptor =3D basic_socket_acceptor; ///< A TCP acceptor. > - using iostream =3D basic_socket_iostream; /// A TCP iostream. > + using iostream =3D 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/l= imits > 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 =3D -1, /// Intermediate. > - round_toward_zero =3D 0, /// To zero. > - round_to_nearest =3D 1, /// To the nearest representabl= e value. > - round_toward_infinity =3D 2, /// To infinity. > - round_toward_neg_infinity =3D 3 /// To negative infinity. > + round_indeterminate =3D -1, ///< Intermediate. > + round_toward_zero =3D 0, ///< To zero. > + round_to_nearest =3D 1, ///< To the nearest representab= le value. > + round_toward_infinity =3D 2, ///< To infinity. > + round_toward_neg_infinity =3D 3 ///< To negative infinity. > }; > > /** > -- > 2.37.3 >