diff options
| author | Arsen Arsenović <arsen@aarsen.me> | 2022-10-01 20:40:05 +0200 |
|---|---|---|
| committer | Jonathan Wakely <jwakely@redhat.com> | 2022-10-04 09:43:57 +0100 |
| commit | 49c3e9dfc5e23a335f4057efffbff2273e3c4631 (patch) | |
| tree | 034aea739920e225592230d52c29b1fc0ef8d877 /libstdc++-v3 | |
| parent | b6d5d72bd0b71ac96a8b2ee537367c46107dcb73 (diff) | |
| download | gcc-49c3e9dfc5e23a335f4057efffbff2273e3c4631.zip gcc-49c3e9dfc5e23a335f4057efffbff2273e3c4631.tar.gz gcc-49c3e9dfc5e23a335f4057efffbff2273e3c4631.tar.bz2 | |
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.
Diffstat (limited to 'libstdc++-v3')
| -rw-r--r-- | libstdc++-v3/include/experimental/internet | 2 | ||||
| -rw-r--r-- | libstdc++-v3/include/std/iostream | 16 | ||||
| -rw-r--r-- | 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 6e3c355..6911989 100644 --- a/libstdc++-v3/include/experimental/internet +++ b/libstdc++-v3/include/experimental/internet @@ -2139,7 +2139,7 @@ namespace ip using resolver = basic_resolver<tcp>; ///< A TCP resolver. using socket = basic_stream_socket<tcp>; ///< A TCP socket. using acceptor = basic_socket_acceptor<tcp>; ///< A TCP acceptor. - using iostream = basic_socket_iostream<tcp>; /// A TCP iostream. + using iostream = basic_socket_iostream<tcp>; ///< 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 685d29a..02e9c30 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 66201fa..a60611b 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. }; /** |