From: Jonathan Wakely <jwakely@redhat.com>
To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org
Subject: [committed] libstdc++: Use markdown in Doxygen comment
Date: Fri, 14 Oct 2022 10:11:35 +0100 [thread overview]
Message-ID: <20221014091135.2477155-1-jwakely@redhat.com> (raw)
Pushed to trunk.
-- >8 --
This makes the comment easier to read in the source, without altering
the Doxygen output.
libstdc++-v3/ChangeLog:
* include/std/iostream: Use markdown in Doxygen comment.
---
libstdc++-v3/include/std/iostream | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/libstdc++-v3/include/std/iostream b/libstdc++-v3/include/std/iostream
index 02e9c3039d1..70318a45891 100644
--- a/libstdc++-v3/include/std/iostream
+++ b/libstdc++-v3/include/std/iostream
@@ -48,13 +48,13 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
/**
* @name Standard Stream Objects
*
- * The <iostream> header declares the eight <em>standard stream
- * objects</em>. For other declarations, see
+ * The `<iostream>` header declares the eight *standard stream objects*.
+ * For other declarations, see
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/io.html
* and the @link iosfwd I/O forward declarations @endlink
*
* They are required by default to cooperate with the global C
- * library's @c FILE streams, and to be available during program
+ * library's `FILE` streams, and to be available during program
* startup and termination. For more information, see the section of the
* manual linked to above.
*/
--
2.37.3
reply other threads:[~2022-10-14 9:11 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221014091135.2477155-1-jwakely@redhat.com \
--to=jwakely@redhat.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=libstdc++@gcc.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).