doc/sod.sty: Add commentary to help following `\parse@dhd' and friends.

[sod] / doc / sod.sty

diff --git a/doc/sod.sty b/doc/sod.sty
index 1f653c9..d3e7740 100644 (file)
--- a/doc/sod.sty
+++ b/doc/sod.sty
@@ -57,6 +57,15 @@
 %% Listings don't need to be small.
 \let\listingsize\relax
 
+%% Notes for later.
+\def\fixme#1{\leavevmode\marginpar{FIXME}\index{FIXME}[FIXME: #1]}
+
+%% Diagram settings.
+\tikzset{
+  every picture/.style={>=stealth, thick},
+  lit/.style={font=\sffamily}
+}
+
 %% Metavariables are italics without decoration.
 \def\syntleft{\normalfont\itshape}
 \let\syntright\empty
@@ -69,6 +78,7 @@
 }
 \def\ulitleft{\normalfont\codeface}
 \let\ulitright\empty
+\def\lit@i#1#2#3{\ifmmode\leavevmode\hbox\fi{#1{#3\/}#2}}
 
 %% Conditionally enter maths mode.  Can't use \ensuremath here because we
 %% aren't necessarily sure where the maths will actually end.
@@ -136,6 +146,7 @@
 \def\ind{\quad\=\+\kill}
 \def\@progcr{\futurelet\@tempa\@progcr@i}
 {\def\:{\gdef\@progcr@sp}\: {\@progcr}}
+\atdef~{\textasciitilde}
 \def\@progcr@i{%
   \ifx\@tempa\@sptoken\let\next@\@progcr@sp\else
   \if1\ifx\@tempa[1\else
@@ -152,6 +163,7 @@
 \def\@progcr@ii#1{\csname @progcr@#1\endcsname\ignorespaces}
 \@namedef{@progcr@+}{\prog@@cr[\medskipamount]}
 \@namedef{@progcr@-}{\prog@@cr*[\jot]}
+\def\macsl{\`\textbackslash\hskip\leftmargin}
 
 %% Put a chunk of text in a box.
 \newenvironment{boxy}[1][\q@]{%
@@ -185,6 +197,7 @@
 \definedescribecategory{be-meth}{before method}
 \definedescribecategory{af-meth}{after method}
 \definedescribecategory{cls}{class}
+\definedescribecategory{rst}{restart}
 \definedescribecategory{ty}{type}
 \definedescribecategory{type}{type}
 \definedescribecategory{mac}{macro}
@@ -197,14 +210,23 @@
 \def\nlret{\\\hspace{4em}\returns}
 
 \def\q@{\q@}
-\def\parse@dhd#1{\@ifnextchar[{\parse@dhd@a{#1}}{\parse@dhd@c{#1}}}
-\def\parse@dhd@a#1[#2]{#1{#2}}
-\def\parse@dhd@c#1#2#3{\parse@dhd@cc{#1}{#2}{#3}#3 \q@}
-\def\parse@dhd@cc#1#2#3#4 #5\q@{#1{#4}{#2}{#3}}
+
+%% \parse@dhd{NEXT}[NAME]{CAT}{SYNOPSIS}
+%% call NEXT{NAME}{CAT}{SYNOPSIS}
+%%            #1    #2     #3
+\def\parse@dhd#1{%  {NEXT}
+  \@ifnextchar[{\parse@dhd@cc{#1}}{\parse@dhd@cd{#1}}}
+\def\parse@dhd@cc#1[#2]#3#4{%  {NEXT}[NAME]{CAT}{SYNOPSIS}
+  #1{#2}{#3}{#4}}
+\def\parse@dhd@cd#1#2#3{%  {NEXT}{CAT}{SYNOPSIS}
+  \parse@dhd@ce{#1}{#2}{#3}#3 \q@}
+\def\parse@dhd@ce#1#2#3#4 #5\q@{%
+  % {NEXT}{CAT}{SYNOPSIS}NAME [ARGS...]\q@
+  #1{#4}{#2}{#3}}
 
 \newif\if@dheadfirst
 \def\dhead{\parse@dhd\dhead@}
-\def\dhead@#1#2#3{%
+\def\dhead@#1#2#3{%  {NAME}{CAT}{SYNOPSIS}
   \if@dheadfirst\global\@dheadfirstfalse\else\relax\\[\smallskipamount]\fi%
   {\let\protect\@empty\def\@uscore{_\@gobble}\message{#2:#1}%
    \def\@uscore{-\@gobble}\edef\@tempa{\noexpand\label{#2:#1}}\@tempa}%