Skip to content

Commit b62ea63

Browse files
committed
Misc. small editorial cleanups.
Based on feedback from Daniel Krügler.
1 parent cae4c12 commit b62ea63

9 files changed

+38
-35
lines changed

any.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ <h1><code>any</code> construct/destruct</h1>
108108
<cxx-function>
109109
<cxx-signature>any() noexcept;</cxx-signature>
110110

111-
<cxx-postconditions><code>this-&gt;empty()</code></cxx-postconditions>
111+
<cxx-postconditions><code>this-&gt;empty()</code>.</cxx-postconditions>
112112
</cxx-function>
113113

114114
<cxx-function>
@@ -152,15 +152,15 @@ <h1><code>any</code> assignments</h1>
152152

153153
<cxx-effects><code>any(rhs).swap(*this)</code>.
154154
No effects if an exception is thrown.</cxx-effects>
155-
<cxx-returns><code>*this</code></cxx-returns>
155+
<cxx-returns><code>*this</code>.</cxx-returns>
156156
<cxx-throws>Any exceptions arising from the copy constructor of the contained object.</cxx-throws>
157157
</cxx-function>
158158

159159
<cxx-function>
160160
<cxx-signature>any&amp; operator=(any&amp;&amp; rhs) noexcept;</cxx-signature>
161161

162162
<cxx-effects><code>any(std::move(rhs)).swap(*this)</code>.</cxx-effects>
163-
<cxx-returns><code>*this</code></cxx-returns>
163+
<cxx-returns><code>*this</code>.</cxx-returns>
164164
<cxx-postconditions>The state of <code>*this</code> is equivalent to the original state of <code>rhs</code>
165165
and <code>rhs</code> is left in a valid but otherwise unspecified state.</cxx-postconditions>
166166
</cxx-function>
@@ -174,7 +174,7 @@ <h1><code>any</code> assignments</h1>
174174
If <code>is_copy_constructible_v&lt;T&gt;</code> is false, the program is ill-formed.</cxx-requires>
175175
<cxx-effects>Constructs an object <code>tmp</code> of type <code>any</code> that contains an object of type <code>T</code> direct-initialized with <code>std::forward&lt;ValueType&gt;(rhs)</code>, and <code>tmp.swap(*this)</code>.
176176
No effects if an exception is thrown.</cxx-effects>
177-
<cxx-returns><code>*this</code></cxx-returns>
177+
<cxx-returns><code>*this</code>.</cxx-returns>
178178
<cxx-remarks> This operator shall not participate in overload resolution if <code>decay_t&lt;ValueType&gt;</code> is the same type as <code>any</code>.</cxx-remarks>
179179
<cxx-throws>Any exception thrown by the selected constructor of <code>T</code>.</cxx-throws>
180180
</cxx-function>

cxx14_index.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
"algorithms.general": "25.1",
6868
"rand.req.genl": "26.5.1.1",
6969
"rand.req.urng": "26.5.1.3",
70+
"rand.predef": "26.5.5",
7071
"rand.dist.uni.int": "26.5.8.2.1",
7172
"futures.promise": "30.6.5",
7273
"futures.task": "30.6.9",

func.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,14 +205,14 @@ <h1><code>function</code> construct/copy/destroy</h1>
205205
<cxx-signature>function&amp; operator=(const function&amp; f);</cxx-signature>
206206

207207
<cxx-effects><code>function(allocator_arg, <em>ALLOCATOR_OF</em>(*this), f).swap(*this);</code></cxx-effects>
208-
<cxx-returns><code>*this</code></cxx-returns>
208+
<cxx-returns><code>*this</code>.</cxx-returns>
209209
</cxx-function>
210210

211211
<cxx-function>
212212
<cxx-signature>function&amp; operator=(function&amp;&amp; f);</cxx-signature>
213213

214214
<cxx-effects><code>function(allocator_arg, <em>ALLOCATOR_OF</em>(*this), std::move(f)).swap(*this);</code></cxx-effects>
215-
<cxx-returns><code>*this</code></cxx-returns>
215+
<cxx-returns><code>*this</code>.</cxx-returns>
216216
</cxx-function>
217217

218218
<cxx-ednote>The following <i>Effects</i> element has been fixed and syncs the wording "<code>*this != NULL</code>"
@@ -225,21 +225,21 @@ <h1><code>function</code> construct/copy/destroy</h1>
225225
<cxx-postconditions><code>!(*this)</code>.
226226
The memory resource returned by <code>get_memory_resource()</code> after the assignment is equivalent to the memory resource before the assignment.
227227
<cxx-note>the address returned by <code>get_memory_resource()</code> might change</cxx-note></cxx-postconditions>
228-
<cxx-returns><code>*this</code></cxx-returns>
228+
<cxx-returns><code>*this</code>.</cxx-returns>
229229
</cxx-function>
230230

231231
<cxx-function>
232232
<cxx-signature>template&lt;class F&gt; function&amp; operator=(F&amp;&amp; f);</cxx-signature>
233233

234234
<cxx-effects><code>function(allocator_arg, <em>ALLOCATOR_OF</em>(*this), std::forward&lt;F&gt;(f)).swap(*this);</code></cxx-effects>
235-
<cxx-returns><code>*this</code></cxx-returns>
235+
<cxx-returns><code>*this</code>.</cxx-returns>
236236
</cxx-function>
237237

238238
<cxx-function>
239239
<cxx-signature>template&lt;class F&gt; function&amp; operator=(reference_wrapper&lt;F&gt; f);</cxx-signature>
240240

241241
<cxx-effects><code>function(allocator_arg, <em>ALLOCATOR_OF</em>(*this), f).swap(*this);</code></cxx-effects>
242-
<cxx-returns><code>*this</code></cxx-returns>
242+
<cxx-returns><code>*this</code>.</cxx-returns>
243243
</cxx-function>
244244
</cxx-section>
245245

iterator.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h1><code>ostream_joiner</code> operations</h1>
9898

9999
<cxx-function>
100100
<cxx-signature>template&lt;typename T&gt;
101-
ostream_joiner&lt;DelimT, charT, traits&gt;&amp; operator=(const T&amp; value);</cxx-signature>
101+
ostream_joiner&amp; operator=(const T&amp; value);</cxx-signature>
102102

103103
<cxx-effects>
104104
<pre style="clear:left"><code>if (!first_element)
@@ -110,16 +110,16 @@ <h1><code>ostream_joiner</code> operations</h1>
110110
</cxx-function>
111111

112112
<cxx-function>
113-
<cxx-signature>ostream_joiner&lt;DelimT, charT, traits&gt;&amp; operator*() noexcept;</cxx-signature>
113+
<cxx-signature>ostream_joiner&amp; operator*() noexcept;</cxx-signature>
114114

115-
<cxx-returns><code>*this</code></cxx-returns>
115+
<cxx-returns><code>*this</code>.</cxx-returns>
116116
</cxx-function>
117117

118118
<cxx-function>
119-
<cxx-signature>ostream_joiner&lt;DelimT, charT, traits&gt;&amp; operator++() noexcept;</cxx-signature>
120-
<cxx-signature>ostream_joiner&lt;DelimT, charT, traits&gt;&amp; operator++(int) noexcept;</cxx-signature>
119+
<cxx-signature>ostream_joiner&amp; operator++() noexcept;</cxx-signature>
120+
<cxx-signature>ostream_joiner&amp; operator++(int) noexcept;</cxx-signature>
121121

122-
<cxx-returns><code>*this</code></cxx-returns>
122+
<cxx-returns><code>*this</code>.</cxx-returns>
123123
</cxx-function>
124124
</cxx-section>
125125

memory.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ <h1><code>shared_ptr</code> constructors</h1>
395395

396396
<cxx-effects>Constructs a <code>shared_ptr</code> instance that stores <code>p</code> and <i>shares ownership</i> with <code>r</code>.</cxx-effects>
397397

398-
<cxx-postconditions><code>get() == p &amp;&amp; use_count() == r.use_count()</code></cxx-postconditions>
398+
<cxx-postconditions><code>get() == p &amp;&amp; use_count() == r.use_count()</code>.</cxx-postconditions>
399399

400400
<p>
401401
<cxx-note>To avoid the possibility of a dangling pointer, the user of this constructor must ensure that <code>p</code> remains valid at least until the ownership group of <code>r</code> is destroyed.</cxx-note>
@@ -502,7 +502,7 @@ <h1><code>shared_ptr</code> casts</h1>
502502

503503
<cxx-requires>The expression <code>static_cast&lt;T*&gt;((U*)0)</code> shall be well formed.</cxx-requires>
504504

505-
<cxx-returns><code>shared_ptr&lt;T&gt;(r, static_cast&lt;typename shared_ptr&lt;T&gt;::element_type*&gt;(r.get()))</code></cxx-returns>
505+
<cxx-returns><code>shared_ptr&lt;T&gt;(r, static_cast&lt;typename shared_ptr&lt;T&gt;::element_type*&gt;(r.get()))</code>.</cxx-returns>
506506

507507
<p>
508508
<cxx-note>The seemingly equivalent expression <code>shared_ptr&lt;T>(static_cast&lt;T*>(r.get()))</code> will eventually result in undefined behavior, attempting to delete the same object twice.</cxx-note>
@@ -902,7 +902,7 @@ <h1><code>polymorphic_allocator</code> constructors</h1>
902902

903903
<cxx-requires><code>r</code> is non-null.</cxx-requires>
904904
<cxx-effects>Sets <code>m_resource</code> to <code>r</code>.</cxx-effects>
905-
<cxx-throws>Nothing</cxx-throws>
905+
<cxx-throws>Nothing.</cxx-throws>
906906
<cxx-notes>This constructor provides an implicit conversion from <code>memory_resource*</code>.</cxx-notes>
907907
</cxx-function>
908908

@@ -1035,7 +1035,7 @@ <h1>polymorphic_allocator equality</h1>
10351035
<cxx-signature>template &lt;class T1, class T2>
10361036
bool operator!=(const polymorphic_allocator&lt;T1>& a,
10371037
const polymorphic_allocator&lt;T2>& b) noexcept;</cxx-signature>
1038-
<cxx-returns><code>! (a == b)</code></cxx-returns>
1038+
<cxx-returns><code>! (a == b)</code>.</cxx-returns>
10391039
</cxx-function>
10401040
</cxx-section>
10411041
</cxx-section>
@@ -1379,7 +1379,7 @@ <h1>pool resource members</h1>
13791379

13801380
<cxx-effects>Return the memory at <code>p</code> to the pool.
13811381
It is unspecified if or under what circumstances this operation will result in a call to <code>upstream_resource()->deallocate()</code>.</cxx-effects>
1382-
<cxx-throws>Nothing</cxx-throws>
1382+
<cxx-throws>Nothing.</cxx-throws>
13831383
</cxx-function>
13841384

13851385
<cxx-function>
@@ -1520,8 +1520,8 @@ <h1>monotonic_buffer_resource members</h1>
15201520

15211521
<cxx-function>
15221522
<cxx-signature>void do_deallocate(void* p, size_t bytes, size_t alignment);</cxx-signature>
1523-
<cxx-effects>None</cxx-effects>
1524-
<cxx-throws>Nothing</cxx-throws>
1523+
<cxx-effects>None.</cxx-effects>
1524+
<cxx-throws>Nothing.</cxx-throws>
15251525
<cxx-remarks>Memory used by this resource increases monotonically until its destruction.</cxx-remarks>
15261526
</cxx-function>
15271527

numeric.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,16 @@ <h1>Header <code>&lt;experimental/random></code> synopsis</h1>
9090
<h1>Utilities</h1>
9191
<cxx-section id="rand.util.randint">
9292
<h1>Function template <code>randint</code></h1>
93-
<p>A separate <dfn>per-thread engine</dfn> of type <code>default_random_engine</code>,
94-
initialized to an unpredictable state, shall be maintained for each thread.</p>
93+
<p>A separate <dfn>per-thread engine</dfn> of type <code>default_random_engine</code>
94+
(<cxx-ref in="cxx" to="rand.predef"></cxx-ref>), initialized to an
95+
unpredictable state, shall be maintained for each thread.</p>
9596
<cxx-function>
9697
<cxx-signature>template&lt;class IntType>
9798
IntType randint(IntType a, IntType b);</cxx-signature>
98-
<cxx-requires><code>a</code><code>b</code>. If the template argument
99-
does not meet the requirements for <code>IntType</code> (<cxx-ref in="cxx" to="rand.req.genl"></cxx-ref>),
100-
the program is ill-formed.</cxx-requires>
99+
<cxx-requires><code>a</code><code>b</code>.</cxx-requires>
100+
<cxx-remarks>If the template argument does not meet the requirements
101+
for <code>IntType</code> (<cxx-ref in="cxx" to="rand.req.genl"></cxx-ref>),
102+
the program is ill-formed.</cxx-remarks>
101103
<cxx-returns>A random integer <var>i</var>, <code>a</code><var>i</var><code>b</code>,
102104
produced from a thread-local instance of <code>uniform_int_distribution&lt;IntType></code>
103105
(<cxx-ref in="cxx" to="rand.dist.uni.int"></cxx-ref>) invoked with the

optional.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ <h1>Observers</h1>
441441
<cxx-signature>constexpr T&amp;&amp; operator*() &amp;&amp;;</cxx-signature>
442442
<cxx-signature>constexpr const T&amp;&amp; operator*() const &amp;&amp;;</cxx-signature>
443443

444-
<cxx-requires><code>*this</code> contains a value</cxx-requires>
444+
<cxx-requires><code>*this</code> contains a value.</cxx-requires>
445445
<cxx-effects>Equivalent to <code>return std::move(*<var>val</var>);</code></cxx-effects>
446446
</cxx-function>
447447

string.view.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ <h1><code>basic_string_view</code> iterator support</h1>
268268
<cxx-signature>constexpr const_iterator end() const noexcept;</cxx-signature>
269269
<cxx-signature>constexpr const_iterator cend() const noexcept;</cxx-signature>
270270

271-
<cxx-returns> <code>begin() + size()</code></cxx-returns>
271+
<cxx-returns> <code>begin() + size()</code>.</cxx-returns>
272272
</cxx-function>
273273

274274
<cxx-function>
@@ -291,7 +291,7 @@ <h1><code>basic_string_view</code> capacity</h1>
291291

292292
<cxx-function>
293293
<cxx-signature>constexpr size_type size() const noexcept;</cxx-signature>
294-
<cxx-returns><code>size_</code></cxx-returns>
294+
<cxx-returns><code>size_</code>.</cxx-returns>
295295
</cxx-function>
296296

297297
<cxx-function>
@@ -317,7 +317,7 @@ <h1><code>basic_string_view</code> element access</h1>
317317
<cxx-signature>constexpr const_reference operator[](size_type pos) const;</cxx-signature>
318318

319319
<cxx-requires><code>pos &lt; size()</code>.</cxx-requires>
320-
<cxx-returns><code>data_[pos]</code></cxx-returns>
320+
<cxx-returns><code>data_[pos]</code>.</cxx-returns>
321321
<cxx-throws>Nothing.</cxx-throws>
322322
<p><cxx-note>Unlike <code>basic_string::operator[]</code>,
323323
<code>basic_string_view::operator[](size())</code> has undefined behavior instead of returning <code>charT()</code>.</cxx-note></p>
@@ -349,7 +349,7 @@ <h1><code>basic_string_view</code> element access</h1>
349349
<cxx-function>
350350
<cxx-signature>constexpr const_pointer data() const noexcept;</cxx-signature>
351351

352-
<cxx-returns><code>data_</code></cxx-returns>
352+
<cxx-returns><code>data_</code>.</cxx-returns>
353353
<p><cxx-note>Unlike <code>basic_string::data()</code> and string literals,
354354
<code>data()</code> may return a pointer to a buffer that is not null-terminated.
355355
Therefore it is typically a mistake to pass <code>data()</code> to a routine that takes just a <code>const charT*</code> and expects a null-terminated string.</cxx-note></p>
@@ -362,14 +362,14 @@ <h1><code>basic_string_view</code> modifiers</h1>
362362
<cxx-function>
363363
<cxx-signature>constexpr void remove_prefix(size_type n);</cxx-signature>
364364

365-
<cxx-requires><code>n &lt;= size()</code></cxx-requires>
365+
<cxx-requires><code>n &lt;= size()</code>.</cxx-requires>
366366
<cxx-effects>Equivalent to <code>data_ += n; size_ -= n;</code></cxx-effects>
367367
</cxx-function>
368368

369369
<cxx-function>
370370
<cxx-signature>constexpr void remove_suffix(size_type n);</cxx-signature>
371371

372-
<cxx-requires><code>n &lt;= size()</code></cxx-requires>
372+
<cxx-requires><code>n &lt;= size()</code>.</cxx-requires>
373373
<cxx-effects>Equivalent to <code>size_ -= n;</code></cxx-effects>
374374
</cxx-function>
375375

utilities.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ <h1>Header <code>&lt;experimental/utility></code> synopsis</h1>
1313
namespace experimental {
1414
inline namespace fundamentals_v2 {
1515

16-
<cxx-ref to="utility.erased.type"></cxx-ref>, erased-type placeholder
16+
<cxx-ref insynopsis="" to="utility.erased.type"></cxx-ref>
1717
struct erased_type { };
1818

1919
} // namespace fundamentals_v2

0 commit comments

Comments
 (0)