Skip to content

[support, diagnostics] Turn synopses into numbered sections #569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 23, 2015
Merged

[support, diagnostics] Turn synopses into numbered sections #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7bcdb21
[support] Turn synopses into numbered sections
tkoeppe Nov 20, 2015
3449445
[diagnostics] Turn synopses into numbered sections
tkoeppe Nov 20, 2015
6ff1290
[xref] Update xrefs following 7bcdb21 and 3449445
tkoeppe Nov 23, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/diagnostics.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@
defines several types of predefined exceptions for reporting errors in a \Cpp program.
These exceptions are related by inheritance.

\synopsis{Header \tcode{<stdexcept>} synopsis}

\rSec2[stdexcept.syn]{Header \tcode{<stdexcept>} synopsis}
\indexlibrary{\idxhdr{stdexcept}}%
\indexlibrary{\idxcode{logic_error}}%
\indexlibrary{\idxcode{domain_error}}%
Expand All @@ -60,6 +59,7 @@
\indexlibrary{\idxcode{range_error}}%
\indexlibrary{\idxcode{overflow_error}}%
\indexlibrary{\idxcode{underflow_error}}%

\begin{codeblock}
namespace std {
class logic_error;
Expand Down Expand Up @@ -681,8 +681,7 @@
Implementations should leave the error states provided by other
libraries unchanged.

\synopsis{Header \tcode{<system_error>} synopsis}

\rSec2[system_error.syn]{Header \tcode{<system_error>} synopsis}
\indexlibrary{\idxcode{error_category}}%
\indexlibrary{\idxcode{error_code}}%
\indexlibrary{\idxcode{error_condition}}%
Expand All @@ -692,6 +691,7 @@
\indexlibrary{\idxcode{errc}}%
\indexlibrary{\idxcode{make_error_code}}%
\indexlibrary{\idxcode{make_error_condition}}%

\begin{codeblock}
namespace std {
class error_category;
Expand Down
18 changes: 10 additions & 8 deletions source/support.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,13 +189,13 @@
Non-arithmetic standard types, such as
\tcode{complex<T>}~(\ref{complex}), shall not have specializations.

\rSec3[limits.syn]{Header \tcode{<limits>} synopsis}
\indextext{\idxhdr{limits}}%
\indexlibrary{\idxhdr{limits}}%
\indextext{\idxcode{numeric_limits}}%
\indexlibrary{\idxcode{numeric_limits}}%
\indexlibrary{\idxcode{float_round_style}}%
\indexlibrary{\idxcode{float_denorm_style}}%
\rSec3[limits.syn]{Header \tcode{<limits>} synopsis}

\begin{codeblock}
namespace std {
Expand Down Expand Up @@ -1171,6 +1171,7 @@
\xref ISO C~7.1.5, 5.2.4.2.2, 5.2.4.2.1.

\rSec1[cstdint]{Integer types}

\rSec2[cstdint.syn]{Header \tcode{<cstdint>} synopsis}
\indextext{\idxhdr{cstdint}}%
\indexlibrary{\idxhdr{cstdint}}%
Expand Down Expand Up @@ -1202,6 +1203,7 @@
\indexlibrary{\idxcode{uint_least64_t}}%
\indexlibrary{\idxcode{uintmax_t}}%
\indexlibrary{\idxcode{uintptr_t}}%

\begin{codeblock}
namespace std {
typedef @\textit{signed integer type}@ int8_t; // optional
Expand Down Expand Up @@ -1505,7 +1507,7 @@
functions that manage the allocation of dynamic storage in a program.
It also defines components for reporting storage management errors.

\synopsis{Header \tcode{<new>} synopsis}
\rSec2[new.syn]{Header \tcode{<new>} synopsis}
\indextext{\idxhdr{new}}%
\indexlibrary{\idxhdr{new}}%

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

\rSec2[typeinfo.syn]{Header \tcode{<typeinfo>} synopsis}
\indextext{\idxhdr{typeinfo}}%
\indexlibrary{\idxhdr{typeinfo}}%
\synopsis{Header \tcode{<typeinfo>} synopsis}

\indexlibrary{\idxcode{type_info}}%
\indexlibrary{\idxcode{bad_cast}}%
\indexlibrary{\idxcode{bad_typeid}}%

\begin{codeblock}
namespace std {
class type_info;
Expand Down Expand Up @@ -2523,10 +2525,10 @@
\tcode{<exception>}
defines several types and functions related to the handling of exceptions in a \Cpp program.

\synopsis{Header \tcode{<exception>} synopsis}

\rSec2[exception.syn]{Header \tcode{<exception>} synopsis}
\indextext{\idxhdr{exception}}%
\indexlibrary{\idxhdr{exception}}%

\begin{codeblock}
namespace std {
class exception;
Expand Down Expand Up @@ -3045,11 +3047,11 @@
The header \tcode{<initializer_list>} defines a class template and several
support functions related to list-initialization~(see \ref{dcl.init.list}).

\synopsis{Header \tcode{<initializer_list>} synopsis}

\rSec2[initializer_list.syn]{Header \tcode{<initializer_list>} synopsis}
\indexlibrary{\idxcode{initializer_list}}%
\indexlibrary{\idxcode{begin}}%
\indexlibrary{\idxcode{end}}%

\begin{codeblock}
namespace std {
template<class E> class initializer_list {
Expand Down
12 changes: 12 additions & 0 deletions source/xref.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
array.size\quad\ref{array.size}\\
array.special\quad\ref{array.special}\\
array.swap\quad\ref{array.swap}\\
array.syn\quad\ref{array.syn}\\
array.tuple\quad\ref{array.tuple}\\
array.zero\quad\ref{array.zero}\\
assertions\quad\ref{assertions}\\
Expand Down Expand Up @@ -457,6 +458,7 @@
deque.modifiers\quad\ref{deque.modifiers}\\
deque.overview\quad\ref{deque.overview}\\
deque.special\quad\ref{deque.special}\\
deque.syn\quad\ref{deque.syn}\\
derivation\quad\ref{derivation}\\
derived.classes\quad\ref{derived.classes}\\
description\quad\ref{description}\\
Expand Down Expand Up @@ -492,6 +494,7 @@
diff.cpp11.expr\quad\ref{diff.cpp11.expr}\\
diff.cpp11.input.output\quad\ref{diff.cpp11.input.output}\\
diff.cpp11.lex\quad\ref{diff.cpp11.lex}\\
diff.cpp11.library\quad\ref{diff.cpp11.library}\\
diff.cpp11.special\quad\ref{diff.cpp11.special}\\
diff.cpp14\quad\ref{diff.cpp14}\\
diff.cpp14.dcl.dcl\quad\ref{diff.cpp14.dcl.dcl}\\
Expand Down Expand Up @@ -532,6 +535,7 @@
except.uncaught\quad\ref{except.uncaught}\\
except.unexpected\quad\ref{except.unexpected}\\
exception\quad\ref{exception}\\
exception.syn\quad\ref{exception.syn}\\
exception.terminate\quad\ref{exception.terminate}\\
exception.unexpected\quad\ref{exception.unexpected}\\
expr\quad\ref{expr}\\
Expand Down Expand Up @@ -612,6 +616,7 @@
forwardlist.ops\quad\ref{forwardlist.ops}\\
forwardlist.overview\quad\ref{forwardlist.overview}\\
forwardlist.spec\quad\ref{forwardlist.spec}\\
forward_list.syn\quad\ref{forward_list.syn}\\
fpos\quad\ref{fpos}\\
fpos.members\quad\ref{fpos.members}\\
fpos.operations\quad\ref{fpos.operations}\\
Expand Down Expand Up @@ -700,6 +705,7 @@
indirect.array.assign\quad\ref{indirect.array.assign}\\
indirect.array.comp.assign\quad\ref{indirect.array.comp.assign}\\
indirect.array.fill\quad\ref{indirect.array.fill}\\
initializer_list.syn\quad\ref{initializer_list.syn}\\
inner.product\quad\ref{inner.product}\\
input.iterators\quad\ref{input.iterators}\\
input.output\quad\ref{input.output}\\
Expand Down Expand Up @@ -841,6 +847,7 @@
list.ops\quad\ref{list.ops}\\
list.overview\quad\ref{list.overview}\\
list.special\quad\ref{list.special}\\
list.syn\quad\ref{list.syn}\\
locale\quad\ref{locale}\\
locale.categories\quad\ref{locale.categories}\\
locale.category\quad\ref{locale.category}\\
Expand Down Expand Up @@ -982,6 +989,7 @@
new.delete.placement\quad\ref{new.delete.placement}\\
new.delete.single\quad\ref{new.delete.single}\\
new.handler\quad\ref{new.handler}\\
new.syn\quad\ref{new.syn}\\
nullablepointer.requirements\quad\ref{nullablepointer.requirements}\\
numarray\quad\ref{numarray}\\
numeric.iota\quad\ref{numeric.iota}\\
Expand Down Expand Up @@ -1288,6 +1296,7 @@
std.ios.manip\quad\ref{std.ios.manip}\\
std.iterator.tags\quad\ref{std.iterator.tags}\\
std.manip\quad\ref{std.manip}\\
stdexcept.syn\quad\ref{stdexcept.syn}\\
stmt.ambig\quad\ref{stmt.ambig}\\
stmt.block\quad\ref{stmt.block}\\
stmt.break\quad\ref{stmt.break}\\
Expand Down Expand Up @@ -1425,6 +1434,7 @@
syserr.syserr\quad\ref{syserr.syserr}\\
syserr.syserr.members\quad\ref{syserr.syserr.members}\\
syserr.syserr.overview\quad\ref{syserr.syserr.overview}\\
system_error.syn\quad\ref{system_error.syn}\\
\par \textbf{T}\par
temp\quad\ref{temp}\\
temp.alias\quad\ref{temp.alias}\\
Expand Down Expand Up @@ -1596,6 +1606,7 @@
type.index.overview\quad\ref{type.index.overview}\\
type.index.synopsis\quad\ref{type.index.synopsis}\\
type.info\quad\ref{type.info}\\
typeinfo.syn\quad\ref{typeinfo.syn}\\
\par \textbf{U}\par
uncaught.exceptions\quad\ref{uncaught.exceptions}\\
underflow.error\quad\ref{underflow.error}\\
Expand Down Expand Up @@ -1712,6 +1723,7 @@
vector.modifiers\quad\ref{vector.modifiers}\\
vector.overview\quad\ref{vector.overview}\\
vector.special\quad\ref{vector.special}\\
vector.syn\quad\ref{vector.syn}\\
\par \textbf{W}\par
wide.stream.objects\quad\ref{wide.stream.objects}\\
\par \textbf{X}\par
Expand Down