doc/structures.tex: Confess to a slight lie about header files.
authorMark Wooding <mdw@distorted.org.uk>
Sat, 3 Aug 2019 15:26:27 +0000 (16:26 +0100)
committerMark Wooding <mdw@distorted.org.uk>
Sat, 3 Aug 2019 15:46:25 +0000 (16:46 +0100)
doc/structures.tex

index 9ae64af..d24fbeb 100644 (file)
@@ -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 @|<sod/sod.h>|.
+\ref{sec:structures.root} are declared by the header file
+@|<sod/sod.h>|.\footnote{%
+  This isn't completely true.  The @|SodObject| and @|SodClass| structures
+  are defined in a header called @|<sod/sod-base.h>|, which is generated by
+  the Sod translator; but @|<sod/sod.h>| includes @|<sod/sod-base.h>|, 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.