X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/3a774b55edfea441c1715994924c2999e9202143..4faea17df1052a4c4f44f75b6ed537ebe9598c24:/doc/runtime.tex?ds=inline diff --git a/doc/runtime.tex b/doc/runtime.tex index 2e04639..a8abf85 100644 --- a/doc/runtime.tex +++ b/doc/runtime.tex @@ -42,7 +42,7 @@ calling functions which make use of keyword arguments; see \xref{sec:concepts.ke The header file defines two simple structure types, and a function type which will be described later. -\begin{describe}[struct kwval]{type} +\begin{describe}{type}[struct kwval] {struct kwval \{ \\ \ind const char *kw; \\ const void *val; \-\\ @@ -55,7 +55,7 @@ will be described later. the actual argument type.) \end{describe} -\begin{describe}[struct kwtab]{type} +\begin{describe}{type}[struct kwtab] {struct kwtab \{ \\ \ind const struct kwval *v; \\ size_t n; \-\\ @@ -136,7 +136,7 @@ result will be unbounded recursion or some other bad outcome. The following macros are intended to help with constructing keyword argument lists. Their use is not essential, but may help prevent errors. -\begin{describe}[KWARGS]{mac}{KWARGS(@
)} +\begin{describe}{mac}[KWARGS]{KWARGS(@)} The @ encloses a sequence of keyword arguments expressed as calls to argument consists of a sequence of calls to the keyword-argument macros described below, one after another without any separation. @@ -158,18 +158,18 @@ lists. Their use is not essential, but may help prevent errors. The following keyword-argument macros can be used within the @|KWARGS| @ argument. -\begin{describe}[K]{mac}{K(@, @ , \dots);}
- \dhead[sod_initv]{fun}
+ \dhead{fun}[sod_initv]
{void *sod_initv(const SodClass *@ , va_list @ .
@@ -767,7 +767,7 @@ deallocation, and applications are free to use any suitable mechanism.
\xref{sec:structures.layout.instance}.
\end{describe*}
-\begin{describe}[sod_teardown]{fun}{int sod_teardown(void *@ );}
+\begin{describe}{fun}[sod_teardown]{int sod_teardown(void *@ );}
Tears down an instance of a class, releasing any resources it holds.
This function is a very thin wrapper around sending the @|obj.teardown|
@@ -779,7 +779,7 @@ deallocation, and applications are free to use any suitable mechanism.
\subsubsection{Automatic storage duration}
The following macro constructs an instance with automatic storage duration.
-\begin{describe}[SOD_DECL]{mac}{SOD_DECL(@ );}
+\begin{describe}{fun}[sod_destroy]{int sod_destroy(void *@ );}
Tears down and frees an instance allocated using @|malloc|.
The pointer @ should be an instance pointer, i.e., a pointer to any of