Skip to content

Commit 0963b3d

Browse files
jensmaurertkoeppe
authored andcommitted
[lib] Harmonize introductory comments in synopses (#1775)
Even if no section reference is given, make them lowercase and remove trailing colons.
1 parent 6b6578c commit 0963b3d

File tree

9 files changed

+102
-102
lines changed

9 files changed

+102
-102
lines changed

source/containers.tex

Lines changed: 73 additions & 73 deletions
Large diffs are not rendered by default.

source/future.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,7 +1106,7 @@
11061106
class strstream
11071107
: public basic_iostream<char> {
11081108
public:
1109-
// Types
1109+
// types
11101110
using char_type = char;
11111111
using int_type = char_traits<char>::int_type;
11121112
using pos_type = char_traits<char>::pos_type;
@@ -1118,7 +1118,7 @@
11181118
ios_base::openmode mode = ios_base::in|ios_base::out);
11191119
virtual ~strstream();
11201120

1121-
// Members:
1121+
// members
11221122
strstreambuf* rdbuf() const;
11231123
void freeze(bool freezefl = true);
11241124
int pcount() const;
@@ -1753,7 +1753,7 @@
17531753
\indexlibrary{\idxcode{allocator}}%
17541754
\begin{codeblock}
17551755
namespace std {
1756-
// specialize for \tcode{void}:
1756+
// specialization for \tcode{void}
17571757
template <> class allocator<void> {
17581758
public:
17591759
using value_type = void;

source/iostreams.tex

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -809,10 +809,10 @@
809809
long& iword(int index);
810810
void*& pword(int index);
811811

812-
// destructor:
812+
// destructor
813813
virtual ~ios_base();
814814

815-
// \ref{ios.base.callback}, callbacks;
815+
// \ref{ios.base.callback}, callbacks
816816
enum event { erase_event, imbue_event, copyfmt_event };
817817
using event_callback = void (*)(event, ios_base&, int index);
818818
void register_callback(event_callback fn, int index);
@@ -2932,7 +2932,7 @@
29322932
= ios_base::in | ios_base::out);
29332933
int pubsync();
29342934

2935-
// Get and put areas
2935+
// get and put areas
29362936
// \ref{streambuf.pub.get}, get area
29372937
streamsize in_avail();
29382938
int_type snextc();
@@ -4145,7 +4145,7 @@
41454145
template <class charT, class traits = char_traits<charT>>
41464146
class basic_istream : virtual public basic_ios<charT, traits> {
41474147
public:
4148-
// types (inherited from \tcode{basic_ios}\iref{ios}):
4148+
// types (inherited from \tcode{basic_ios}\iref{ios})
41494149
using char_type = charT;
41504150
using int_type = typename traits::int_type;
41514151
using pos_type = typename traits::pos_type;
@@ -5705,7 +5705,7 @@
57055705
template <class charT, class traits = char_traits<charT>>
57065706
class basic_ostream : virtual public basic_ios<charT, traits> {
57075707
public:
5708-
// types (inherited from \tcode{basic_ios}\iref{ios}):
5708+
// types (inherited from \tcode{basic_ios}\iref{ios})
57095709
using char_type = charT;
57105710
using int_type = typename traits::int_type;
57115711
using pos_type = typename traits::pos_type;
@@ -12588,7 +12588,7 @@
1258812588
file_status(file_status&&) noexcept = default;
1258912589
~file_status();
1259012590

12591-
// assignments:
12591+
// assignments
1259212592
file_status& operator=(const file_status&) noexcept = default;
1259312593
file_status& operator=(file_status&&) noexcept = default;
1259412594

@@ -12679,7 +12679,7 @@
1267912679
directory_entry(const filesystem::path& p, error_code& ec);
1268012680
~directory_entry();
1268112681

12682-
// assignments:
12682+
// assignments
1268312683
directory_entry& operator=(const directory_entry&) = default;
1268412684
directory_entry& operator=(directory_entry&&) noexcept = default;
1268512685

source/locales.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@
122122
namespace std {
123123
class locale {
124124
public:
125-
// types:
125+
// types
126126
class facet;
127127
class id;
128128
using category = int;
@@ -133,7 +133,7 @@
133133
time = 0x100, messages = 0x200,
134134
all = collate | ctype | monetary | numeric | time | messages;
135135

136-
// construct/copy/destroy:
136+
// construct/copy/destroy
137137
locale() noexcept;
138138
locale(const locale& other) noexcept;
139139
explicit locale(const char* std_name);
@@ -146,7 +146,7 @@
146146
const locale& operator=(const locale& other) noexcept;
147147
template <class Facet> locale combine(const locale& other) const;
148148

149-
// locale operations:
149+
// locale operations
150150
basic_string<char> name() const;
151151

152152
bool operator==(const locale& other) const;
@@ -156,7 +156,7 @@
156156
bool operator()(const basic_string<charT, traits, Allocator>& s1,
157157
const basic_string<charT, traits, Allocator>& s2) const;
158158

159-
// global locale objects:
159+
// global locale objects
160160
static locale global(const locale&);
161161
static const locale& classic();
162162
};

source/numerics.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10435,7 +10435,7 @@
1043510435
long double sph_legendrel(unsigned l, unsigned m, long double theta);
1043610436

1043710437
// \ref{sf.cmath.sph_neumann}, spherical Neumann functions;
10438-
// spherical Bessel functions of the second kind:
10438+
// spherical Bessel functions of the second kind
1043910439
double sph_neumann(unsigned n, double x);
1044010440
float sph_neumannf(unsigned n, float x);
1044110441
long double sph_neumannl(unsigned n, long double x);

source/regex.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1329,7 +1329,7 @@
13291329
template <class charT, class traits = regex_traits<charT>>
13301330
class basic_regex {
13311331
public:
1332-
// types:
1332+
// types
13331333
using value_type = charT;
13341334
using traits_type = traits;
13351335
using string_type = typename traits::string_type;

source/strings.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -878,7 +878,7 @@
878878
class Allocator = allocator<charT>>
879879
class basic_string {
880880
public:
881-
// types:
881+
// types
882882
using traits_type = traits;
883883
using value_type = charT;
884884
using allocator_type = Allocator;

source/threads.tex

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -331,11 +331,11 @@
331331
namespace std {
332332
class thread {
333333
public:
334-
// types:
334+
// types
335335
class id;
336336
using native_handle_type = @\impdefnc@; // see~\ref{thread.req.native}
337337

338-
// construct/copy/destroy:
338+
// construct/copy/destroy
339339
thread() noexcept;
340340
template <class F, class... Args> explicit thread(F&& f, Args&&... args);
341341
~thread();
@@ -344,15 +344,15 @@
344344
thread& operator=(const thread&) = delete;
345345
thread& operator=(thread&&) noexcept;
346346

347-
// members:
347+
// members
348348
void swap(thread&) noexcept;
349349
bool joinable() const noexcept;
350350
void join();
351351
void detach();
352352
id get_id() const noexcept;
353353
native_handle_type native_handle(); // see~\ref{thread.req.native}
354354

355-
// static members:
355+
// static members
356356
static unsigned int hardware_concurrency() noexcept;
357357
};
358358
}
@@ -380,7 +380,7 @@
380380
basic_ostream<charT, traits>&
381381
operator<<(basic_ostream<charT, traits>& out, thread::id id);
382382

383-
// Hash support
383+
// hash support
384384
template <class T> struct hash;
385385
template <> struct hash<thread::id>;
386386
}
@@ -1443,12 +1443,12 @@
14431443
shared_mutex(const shared_mutex&) = delete;
14441444
shared_mutex& operator=(const shared_mutex&) = delete;
14451445

1446-
// Exclusive ownership
1446+
// exclusive ownership
14471447
void lock(); // blocking
14481448
bool try_lock();
14491449
void unlock();
14501450

1451-
// Shared ownership
1451+
// shared ownership
14521452
void lock_shared(); // blocking
14531453
bool try_lock_shared();
14541454
void unlock_shared();
@@ -1578,7 +1578,7 @@
15781578
shared_timed_mutex(const shared_timed_mutex&) = delete;
15791579
shared_timed_mutex& operator=(const shared_timed_mutex&) = delete;
15801580

1581-
// Exclusive ownership
1581+
// exclusive ownership
15821582
void lock(); // blocking
15831583
bool try_lock();
15841584
template <class Rep, class Period>
@@ -1587,7 +1587,7 @@
15871587
bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);
15881588
void unlock();
15891589

1590-
// Shared ownership
1590+
// shared ownership
15911591
void lock_shared(); // blocking
15921592
bool try_lock_shared();
15931593
template <class Rep, class Period>

source/utilities.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5701,7 +5701,7 @@
57015701
namespace std {
57025702
template<size_t N> class bitset {
57035703
public:
5704-
// bit reference:
5704+
// bit reference
57055705
class reference {
57065706
friend class bitset;
57075707
reference() noexcept;
@@ -5747,7 +5747,7 @@
57475747
bitset<N>& flip() noexcept;
57485748
bitset<N>& flip(size_t pos);
57495749

5750-
// element access:
5750+
// element access
57515751
constexpr bool operator[](size_t pos) const; // for \tcode{b[i];}
57525752
reference operator[](size_t pos); // for \tcode{b[i];}
57535753

@@ -18658,7 +18658,7 @@
1865818658

1865918659
static time_point now() noexcept;
1866018660

18661-
// Map to C API
18661+
// map to C API
1866218662
static time_t to_time_t (const time_point& t) noexcept;
1866318663
static time_point from_time_t(time_t t) noexcept;
1866418664
};

0 commit comments

Comments
 (0)