Skip to content

Commit 3ee5ff4

Browse files
committed
Merge pull request #569 from tkoeppe/syn
[support], [diagnostics] Turn synopses into numbered sections
2 parents e616330 + 6ff1290 commit 3ee5ff4

File tree

3 files changed

+26
-12
lines changed

3 files changed

+26
-12
lines changed

source/diagnostics.tex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@
4848
defines several types of predefined exceptions for reporting errors in a \Cpp program.
4949
These exceptions are related by inheritance.
5050

51-
\synopsis{Header \tcode{<stdexcept>} synopsis}
52-
51+
\rSec2[stdexcept.syn]{Header \tcode{<stdexcept>} synopsis}
5352
\indexlibrary{\idxhdr{stdexcept}}%
5453
\indexlibrary{\idxcode{logic_error}}%
5554
\indexlibrary{\idxcode{domain_error}}%
@@ -60,6 +59,7 @@
6059
\indexlibrary{\idxcode{range_error}}%
6160
\indexlibrary{\idxcode{overflow_error}}%
6261
\indexlibrary{\idxcode{underflow_error}}%
62+
6363
\begin{codeblock}
6464
namespace std {
6565
class logic_error;
@@ -681,8 +681,7 @@
681681
Implementations should leave the error states provided by other
682682
libraries unchanged.
683683

684-
\synopsis{Header \tcode{<system_error>} synopsis}
685-
684+
\rSec2[system_error.syn]{Header \tcode{<system_error>} synopsis}
686685
\indexlibrary{\idxcode{error_category}}%
687686
\indexlibrary{\idxcode{error_code}}%
688687
\indexlibrary{\idxcode{error_condition}}%
@@ -692,6 +691,7 @@
692691
\indexlibrary{\idxcode{errc}}%
693692
\indexlibrary{\idxcode{make_error_code}}%
694693
\indexlibrary{\idxcode{make_error_condition}}%
694+
695695
\begin{codeblock}
696696
namespace std {
697697
class error_category;

source/support.tex

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -189,13 +189,13 @@
189189
Non-arithmetic standard types, such as
190190
\tcode{complex<T>}~(\ref{complex}), shall not have specializations.
191191

192+
\rSec3[limits.syn]{Header \tcode{<limits>} synopsis}
192193
\indextext{\idxhdr{limits}}%
193194
\indexlibrary{\idxhdr{limits}}%
194195
\indextext{\idxcode{numeric_limits}}%
195196
\indexlibrary{\idxcode{numeric_limits}}%
196197
\indexlibrary{\idxcode{float_round_style}}%
197198
\indexlibrary{\idxcode{float_denorm_style}}%
198-
\rSec3[limits.syn]{Header \tcode{<limits>} synopsis}
199199

200200
\begin{codeblock}
201201
namespace std {
@@ -1171,6 +1171,7 @@
11711171
\xref ISO C~7.1.5, 5.2.4.2.2, 5.2.4.2.1.
11721172

11731173
\rSec1[cstdint]{Integer types}
1174+
11741175
\rSec2[cstdint.syn]{Header \tcode{<cstdint>} synopsis}
11751176
\indextext{\idxhdr{cstdint}}%
11761177
\indexlibrary{\idxhdr{cstdint}}%
@@ -1202,6 +1203,7 @@
12021203
\indexlibrary{\idxcode{uint_least64_t}}%
12031204
\indexlibrary{\idxcode{uintmax_t}}%
12041205
\indexlibrary{\idxcode{uintptr_t}}%
1206+
12051207
\begin{codeblock}
12061208
namespace std {
12071209
typedef @\textit{signed integer type}@ int8_t; // optional
@@ -1505,7 +1507,7 @@
15051507
functions that manage the allocation of dynamic storage in a program.
15061508
It also defines components for reporting storage management errors.
15071509

1508-
\synopsis{Header \tcode{<new>} synopsis}
1510+
\rSec2[new.syn]{Header \tcode{<new>} synopsis}
15091511
\indextext{\idxhdr{new}}%
15101512
\indexlibrary{\idxhdr{new}}%
15111513

@@ -2253,13 +2255,13 @@
22532255
type associated with type information generated by the implementation.
22542256
It also defines two types for reporting dynamic type identification errors.
22552257

2258+
\rSec2[typeinfo.syn]{Header \tcode{<typeinfo>} synopsis}
22562259
\indextext{\idxhdr{typeinfo}}%
22572260
\indexlibrary{\idxhdr{typeinfo}}%
2258-
\synopsis{Header \tcode{<typeinfo>} synopsis}
2259-
22602261
\indexlibrary{\idxcode{type_info}}%
22612262
\indexlibrary{\idxcode{bad_cast}}%
22622263
\indexlibrary{\idxcode{bad_typeid}}%
2264+
22632265
\begin{codeblock}
22642266
namespace std {
22652267
class type_info;
@@ -2523,10 +2525,10 @@
25232525
\tcode{<exception>}
25242526
defines several types and functions related to the handling of exceptions in a \Cpp program.
25252527

2526-
\synopsis{Header \tcode{<exception>} synopsis}
2527-
2528+
\rSec2[exception.syn]{Header \tcode{<exception>} synopsis}
25282529
\indextext{\idxhdr{exception}}%
25292530
\indexlibrary{\idxhdr{exception}}%
2531+
25302532
\begin{codeblock}
25312533
namespace std {
25322534
class exception;
@@ -3045,11 +3047,11 @@
30453047
The header \tcode{<initializer_list>} defines a class template and several
30463048
support functions related to list-initialization~(see \ref{dcl.init.list}).
30473049

3048-
\synopsis{Header \tcode{<initializer_list>} synopsis}
3049-
3050+
\rSec2[initializer_list.syn]{Header \tcode{<initializer_list>} synopsis}
30503051
\indexlibrary{\idxcode{initializer_list}}%
30513052
\indexlibrary{\idxcode{begin}}%
30523053
\indexlibrary{\idxcode{end}}%
3054+
30533055
\begin{codeblock}
30543056
namespace std {
30553057
template<class E> class initializer_list {

source/xref.tex

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
array.size\quad\ref{array.size}\\
9090
array.special\quad\ref{array.special}\\
9191
array.swap\quad\ref{array.swap}\\
92+
array.syn\quad\ref{array.syn}\\
9293
array.tuple\quad\ref{array.tuple}\\
9394
array.zero\quad\ref{array.zero}\\
9495
assertions\quad\ref{assertions}\\
@@ -457,6 +458,7 @@
457458
deque.modifiers\quad\ref{deque.modifiers}\\
458459
deque.overview\quad\ref{deque.overview}\\
459460
deque.special\quad\ref{deque.special}\\
461+
deque.syn\quad\ref{deque.syn}\\
460462
derivation\quad\ref{derivation}\\
461463
derived.classes\quad\ref{derived.classes}\\
462464
description\quad\ref{description}\\
@@ -492,6 +494,7 @@
492494
diff.cpp11.expr\quad\ref{diff.cpp11.expr}\\
493495
diff.cpp11.input.output\quad\ref{diff.cpp11.input.output}\\
494496
diff.cpp11.lex\quad\ref{diff.cpp11.lex}\\
497+
diff.cpp11.library\quad\ref{diff.cpp11.library}\\
495498
diff.cpp11.special\quad\ref{diff.cpp11.special}\\
496499
diff.cpp14\quad\ref{diff.cpp14}\\
497500
diff.cpp14.dcl.dcl\quad\ref{diff.cpp14.dcl.dcl}\\
@@ -532,6 +535,7 @@
532535
except.uncaught\quad\ref{except.uncaught}\\
533536
except.unexpected\quad\ref{except.unexpected}\\
534537
exception\quad\ref{exception}\\
538+
exception.syn\quad\ref{exception.syn}\\
535539
exception.terminate\quad\ref{exception.terminate}\\
536540
exception.unexpected\quad\ref{exception.unexpected}\\
537541
expr\quad\ref{expr}\\
@@ -612,6 +616,7 @@
612616
forwardlist.ops\quad\ref{forwardlist.ops}\\
613617
forwardlist.overview\quad\ref{forwardlist.overview}\\
614618
forwardlist.spec\quad\ref{forwardlist.spec}\\
619+
forward_list.syn\quad\ref{forward_list.syn}\\
615620
fpos\quad\ref{fpos}\\
616621
fpos.members\quad\ref{fpos.members}\\
617622
fpos.operations\quad\ref{fpos.operations}\\
@@ -700,6 +705,7 @@
700705
indirect.array.assign\quad\ref{indirect.array.assign}\\
701706
indirect.array.comp.assign\quad\ref{indirect.array.comp.assign}\\
702707
indirect.array.fill\quad\ref{indirect.array.fill}\\
708+
initializer_list.syn\quad\ref{initializer_list.syn}\\
703709
inner.product\quad\ref{inner.product}\\
704710
input.iterators\quad\ref{input.iterators}\\
705711
input.output\quad\ref{input.output}\\
@@ -841,6 +847,7 @@
841847
list.ops\quad\ref{list.ops}\\
842848
list.overview\quad\ref{list.overview}\\
843849
list.special\quad\ref{list.special}\\
850+
list.syn\quad\ref{list.syn}\\
844851
locale\quad\ref{locale}\\
845852
locale.categories\quad\ref{locale.categories}\\
846853
locale.category\quad\ref{locale.category}\\
@@ -982,6 +989,7 @@
982989
new.delete.placement\quad\ref{new.delete.placement}\\
983990
new.delete.single\quad\ref{new.delete.single}\\
984991
new.handler\quad\ref{new.handler}\\
992+
new.syn\quad\ref{new.syn}\\
985993
nullablepointer.requirements\quad\ref{nullablepointer.requirements}\\
986994
numarray\quad\ref{numarray}\\
987995
numeric.iota\quad\ref{numeric.iota}\\
@@ -1288,6 +1296,7 @@
12881296
std.ios.manip\quad\ref{std.ios.manip}\\
12891297
std.iterator.tags\quad\ref{std.iterator.tags}\\
12901298
std.manip\quad\ref{std.manip}\\
1299+
stdexcept.syn\quad\ref{stdexcept.syn}\\
12911300
stmt.ambig\quad\ref{stmt.ambig}\\
12921301
stmt.block\quad\ref{stmt.block}\\
12931302
stmt.break\quad\ref{stmt.break}\\
@@ -1425,6 +1434,7 @@
14251434
syserr.syserr\quad\ref{syserr.syserr}\\
14261435
syserr.syserr.members\quad\ref{syserr.syserr.members}\\
14271436
syserr.syserr.overview\quad\ref{syserr.syserr.overview}\\
1437+
system_error.syn\quad\ref{system_error.syn}\\
14281438
\par \textbf{T}\par
14291439
temp\quad\ref{temp}\\
14301440
temp.alias\quad\ref{temp.alias}\\
@@ -1596,6 +1606,7 @@
15961606
type.index.overview\quad\ref{type.index.overview}\\
15971607
type.index.synopsis\quad\ref{type.index.synopsis}\\
15981608
type.info\quad\ref{type.info}\\
1609+
typeinfo.syn\quad\ref{typeinfo.syn}\\
15991610
\par \textbf{U}\par
16001611
uncaught.exceptions\quad\ref{uncaught.exceptions}\\
16011612
underflow.error\quad\ref{underflow.error}\\
@@ -1712,6 +1723,7 @@
17121723
vector.modifiers\quad\ref{vector.modifiers}\\
17131724
vector.overview\quad\ref{vector.overview}\\
17141725
vector.special\quad\ref{vector.special}\\
1726+
vector.syn\quad\ref{vector.syn}\\
17151727
\par \textbf{W}\par
17161728
wide.stream.objects\quad\ref{wide.stream.objects}\\
17171729
\par \textbf{X}\par

0 commit comments

Comments
 (0)