Skip to content

Commit 196a629

Browse files
author
Dawn Perchik
committed
Minor edits to library discovered while fixing \effects clauses
* fix punctuation in \returns * add missing \tcodes * break long lines
1 parent 4d54867 commit 196a629

File tree

5 files changed

+33
-25
lines changed

5 files changed

+33
-25
lines changed

source/atomics.tex

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -817,7 +817,7 @@
817817

818818
\begin{itemdescr}
819819
\pnum
820-
\returns True if the object's operations are lock-free, false otherwise.
820+
\returns \tcode{true} if the object's operations are lock-free, \tcode{false} otherwise.
821821
\enternote
822822
The return value of the \tcode{is_lock_free} member function
823823
is consistent with the value of \tcode{is_always_lock_free} for the same type.
@@ -882,7 +882,7 @@
882882
\effects As if by \tcode{store(desired)}.
883883

884884
\pnum
885-
\returns \tcode{desired}
885+
\returns \tcode{desired}.
886886
\end{itemdescr}
887887

888888
\indexlibrary{\idxcode{atomic type}!\idxcode{atomic_load}}%
@@ -1149,7 +1149,7 @@
11491149
\effects As if by \tcode{fetch_\placeholder{key}(operand)}.
11501150

11511151
\pnum
1152-
\returns \tcode{fetch_\placeholder{key}(operand) op operand}
1152+
\returns \tcode{fetch_\placeholder{key}(operand) op operand}.
11531153
\end{itemdescr}
11541154

11551155
\indexlibrary{\idxcode{atomic type}!\idxcode{operator++}}%
@@ -1161,7 +1161,7 @@
11611161

11621162
\begin{itemdescr}
11631163
\pnum
1164-
\returns \tcode{fetch_add(1)}
1164+
\returns \tcode{fetch_add(1)}.
11651165
\end{itemdescr}
11661166

11671167
\indexlibrary{\idxcode{atomic type}!\idxcode{operator\dcr}}%
@@ -1173,7 +1173,7 @@
11731173

11741174
\begin{itemdescr}
11751175
\pnum
1176-
\returns \tcode{fetch_sub(1)}
1176+
\returns \tcode{fetch_sub(1)}.
11771177
\end{itemdescr}
11781178

11791179
\indexlibrary{\idxcode{atomic type}!\idxcode{operator++}}%
@@ -1188,7 +1188,7 @@
11881188
\effects As if by \tcode{fetch_add(1)}.
11891189

11901190
\pnum
1191-
\returns \tcode{fetch_add(1) + 1}
1191+
\returns \tcode{fetch_add(1) + 1}.
11921192
\end{itemdescr}
11931193

11941194
\indexlibrary{\idxcode{atomic type}!\idxcode{operator\dcr}}%
@@ -1203,7 +1203,7 @@
12031203
\effects As if by \tcode{fetch_sub(1)}.
12041204

12051205
\pnum
1206-
\returns \tcode{fetch_sub(1) - 1}
1206+
\returns \tcode{fetch_sub(1) - 1}.
12071207
\end{itemdescr}
12081208

12091209
\rSec1[atomics.flag]{Flag type and operations}
@@ -1276,7 +1276,8 @@
12761276
\tcode{order}. These operations are atomic read-modify-write operations~(\ref{intro.multithread}).
12771277

12781278
\pnum
1279-
\returns Atomically, the value of the object immediately before the effects. \end{itemdescr}
1279+
\returns Atomically, the value of the object immediately before the effects.
1280+
\end{itemdescr}
12801281

12811282
\indexlibrary{\idxcode{atomic_flag_clear}}%
12821283
\indexlibrary{\idxcode{atomic_flag_clear_explicit}}%

source/diagnostics.tex

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1294,7 +1294,11 @@
12941294

12951295
\begin{itemdescr}
12961296
\pnum
1297-
\returns \tcode{lhs.category() < rhs.category() || lhs.category() == rhs.category() \&\& lhs.value() < rhs.value()}.
1297+
\returns
1298+
\begin{codeblock}
1299+
lhs.category() < rhs.category() ||
1300+
(lhs.category() == rhs.category() && lhs.value() < rhs.value()).
1301+
\end{codeblock}
12981302
\end{itemdescr}
12991303

13001304
\indexlibrary{\idxcode{operator\shl}!\idxcode{error_code}}%

source/numerics.tex

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3852,7 +3852,8 @@
38523852
\pnum\effects Constructs a \tcode{random_device}
38533853
non-deterministic uniform random number generator object.
38543854
The semantics and default value of the \tcode{token}
3855-
parameter are implementation-defined.\footnote{ The parameter is intended
3855+
parameter are implementation-defined.
3856+
\footnote{The parameter is intended
38563857
to allow an implementation to differentiate
38573858
between different sources of randomness.
38583859
}
@@ -8656,7 +8657,8 @@
86568657
template<class InputIterator, class UnaryFunction, class T, class BinaryOperation>
86578658
T transform_reduce(InputIterator first, InputIterator last,
86588659
UnaryOperation unary_op, T init, BinaryOperation binary_op);
8659-
template<class ExecutionPolicy, class InputIterator, class UnaryFunction, class T, class BinaryOperation>
8660+
template<class ExecutionPolicy, class InputIterator,
8661+
class UnaryFunction, class T, class BinaryOperation>
86608662
T transform_reduce(ExecutionPolicy&& exec, // see \ref{algorithms.parallel.overloads}
86618663
InputIterator first, InputIterator last,
86628664
UnaryOperation unary_op, T init, BinaryOperation binary_op);
@@ -8706,7 +8708,8 @@
87068708
InputIterator first, InputIterator last,
87078709
OutputIterator result,
87088710
T init);
8709-
template<class ExecutionPolicy, class InputIterator, class OutputIterator, class T, class BinaryOperation>
8711+
template<class ExecutionPolicy, class InputIterator, class OutputIterator, class T,
8712+
class BinaryOperation>
87108713
OutputIterator exclusive_scan(ExecutionPolicy&& exec, // see \ref{algorithms.parallel.overloads}
87118714
InputIterator first, InputIterator last,
87128715
OutputIterator result,
@@ -8726,12 +8729,14 @@
87268729
OutputIterator inclusive_scan(ExecutionPolicy&& exec, // see \ref{algorithms.parallel.overloads}
87278730
InputIterator first, InputIterator last,
87288731
OutputIterator result);
8729-
template<class ExecutionPolicy, class InputIterator, class OutputIterator, class BinaryOperation>
8732+
template<class ExecutionPolicy, class InputIterator, class OutputIterator,
8733+
class BinaryOperation>
87308734
OutputIterator inclusive_scan(ExecutionPolicy&& exec, // see \ref{algorithms.parallel.overloads}
87318735
InputIterator first, InputIterator last,
87328736
OutputIterator result,
87338737
BinaryOperation binary_op);
8734-
template<class ExecutionPolicy, class InputIterator, class OutputIterator, class BinaryOperation, class T>
8738+
template<class ExecutionPolicy, class InputIterator, class OutputIterator,
8739+
class BinaryOperation, class T>
87358740
OutputIterator inclusive_scan(ExecutionPolicy&& exec, // see \ref{algorithms.parallel.overloads}
87368741
InputIterator first, InputIterator last,
87378742
OutputIterator result,
@@ -8948,7 +8953,7 @@
89488953
T inner_product(InputIterator1 first1, InputIterator1 last1,
89498954
InputIterator2 first2, T init);
89508955
template <class InputIterator1, class InputIterator2, class T,
8951-
class BinaryOperation1, class BinaryOperation2>
8956+
class BinaryOperation1, class BinaryOperation2>
89528957
T inner_product(InputIterator1 first1, InputIterator1 last1,
89538958
Inputgterator2 first2, T init,
89548959
BinaryOperation1 binary_op1,
@@ -8998,11 +9003,10 @@
89989003
OutputIterator partial_sum(
89999004
InputIterator first, InputIterator last,
90009005
OutputIterator result);
9001-
template
9002-
<class InputIterator, class OutputIterator, class BinaryOperation>
9003-
OutputIterator partial_sum(
9004-
InputIterator first, InputIterator last,
9005-
OutputIterator result, BinaryOperation binary_op);
9006+
template <class InputIterator, class OutputIterator, class BinaryOperation>
9007+
OutputIterator partial_sum(
9008+
InputIterator first, InputIterator last,
9009+
OutputIterator result, BinaryOperation binary_op);
90069010
\end{itemdecl}
90079011

90089012
\begin{itemdescr}

source/regex.tex

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3483,8 +3483,7 @@
34833483

34843484
\begin{itemdescr}
34853485
\pnum
3486-
\returns \tcode{regex_search(str, str + char_traits<charT>::length(str),
3487-
e, flags)}
3486+
\returns \tcode{regex_search(str, str + char_traits<charT>::length(str), e, flags)}.
34883487
\end{itemdescr}
34893488

34903489
\indexlibrary{\idxcode{regex_search}}%

source/utilities.tex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14643,7 +14643,7 @@
1464314643

1464414644
\begin{itemdescr}
1464514645
\pnum
14646-
\returns \tcode{duration(-rep_);}.
14646+
\returns \tcode{duration(-rep_)}.
1464714647
\end{itemdescr}
1464814648

1464914649
\indexlibrary{\idxcode{operator++}!\idxcode{duration}}%
@@ -14668,7 +14668,7 @@
1466814668

1466914669
\begin{itemdescr}
1467014670
\pnum
14671-
\returns \tcode{duration(rep_++);}.
14671+
\returns \tcode{duration(rep_++)}.
1467214672
\end{itemdescr}
1467314673

1467414674
\indexlibrary{\idxcode{operator\dcr}!\idxcode{duration}}%
@@ -14693,7 +14693,7 @@
1469314693

1469414694
\begin{itemdescr}
1469514695
\pnum
14696-
\returns \tcode{duration(rep_-{}-);}.
14696+
\returns \tcode{duration(rep_-{}-)}.
1469714697
\end{itemdescr}
1469814698

1469914699
\indexlibrary{\idxcode{operator+=}!\idxcode{duration}}%

0 commit comments

Comments
 (0)