X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/ca2023b8567b5e012b373eff8544be7920ce5c17..765231c00c9da4426ed07abc911f80828faa0349:/doc/structures.tex diff --git a/doc/structures.tex b/doc/structures.tex index 9ae64af..242d199 100644 --- a/doc/structures.tex +++ b/doc/structures.tex @@ -32,7 +32,12 @@ works very differently from the standard @|SodObject| described here. The concrete types described in \xref[\instead{sections}]{sec:structures.common} and -\ref{sec:structures.root} are declared by the header file @||. +\ref{sec:structures.root} are declared by the header file +@||.\footnote{% + This isn't completely true. The @|SodObject| and @|SodClass| structures + are defined in a header called @||, which is generated by + the Sod translator; but @|| includes @||, so you + can forget about this detail.} % The definitions described in \xref{sec:structures.layout} are defined in the header file generated by the containing module. @@ -46,7 +51,7 @@ structure. Instance chains contain slots and vtable pointers, as described below. All instances have the basic structure of a @|struct sod_instance|. -\begin{describe}{type}[struct sod_instance] +\begin{describe}{ty}[struct sod_instance] {struct sod_instance \{ \\ \ind const struct sod_vtable *_vt; \-\\ \};} @@ -58,7 +63,7 @@ instances have the basic structure of a @|struct sod_instance|. \end{description} \end{describe} -\begin{describe}{type}[struct sod_vtable] +\begin{describe}{ty}[struct sod_vtable] {struct sod_vtable \{ \\ \ind const SodClass *_class; \\ size_t _base; \-\\ @@ -296,7 +301,7 @@ involved at the top of the class/metaclass graph (see \end{description} \end{describe} -\begin{describe}{type}[struct sod_chain] +\begin{describe}{ty}[struct sod_chain] {struct sod_chain \{ \\ \ind size_t n_classes; \\ const SodClass *const *classes; \\