X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/1818107e8198734df843841a51bca3713bd37596..a44344574992d1ec221afebc664e0ca2a4879460:/doc/misc.tex diff --git a/doc/misc.tex b/doc/misc.tex index de62c8e..33f3310 100644 --- a/doc/misc.tex +++ b/doc/misc.tex @@ -7,7 +7,7 @@ %%%----- Licensing notice --------------------------------------------------- %%% -%%% This file is part of the Sensble Object Design, an object system for C. +%%% This file is part of the Sensible Object Design, an object system for C. %%% %%% SOD is free software; you can redistribute it and/or modify %%% it under the terms of the GNU General Public License as published by @@ -32,17 +32,20 @@ These symbols are defined in the @|sod-utilities| package. \begin{describe}{mac} {with-gensyms (@{ @ @! (@ @[@@]) @}^*) \\ \ind - @^*} + @^* \\ + @
^*} \end{describe} \begin{describe}{mac} {once-only (@[[ :environment @ @]] @{ @ @! (@ @[@@]) @}^*) \\ \ind - @^*} + @^* \\ + @^*} \end{describe} \begin{describe}{mac} - {parse-body @ @> @ @ @} + {parse-body @ \&key :docp :declp + @> @ @ @} \end{describe} \begin{describe}{cls}{loc} @@ -51,7 +54,7 @@ These symbols are defined in the @|sod-utilities| package. \begin{describe}{fun}{locp @ @> @} \end{describe} -\begin{describe}{macro}{locf @ @> @} +\begin{describe}{mac}{locf @ @> @} \end{describe} \begin{describe*} @@ -63,7 +66,8 @@ These symbols are defined in the @|sod-utilities| package. {with-locatives @{ @ @! (@{ @ @! (@ @[@@]) @}^*) @} \\ \ind - @^*} + @^* \\ + @^*} \end{describe} \begin{describe}{sym}{it} @@ -72,7 +76,7 @@ These symbols are defined in the @|sod-utilities| package. \begin{describe}{mac}{aif @ @ @[@@]} \end{describe} -\begin{describe}{mac}{awhen @ @^*} +\begin{describe}{mac}{awhen @ @^*} \end{describe} \begin{describe}{mac}{acond @{ (@ @^*) @}^*} @@ -136,7 +140,8 @@ These symbols are defined in the @|sod-utilities| package. {categorize (\=@ @ @[[ :bind (@{ @ @! (@ @[@@]) @}^*) @]]) \\ \ind\ind - (@{ @ @ @}^*) \- \\ + (@{ (@ @) @}^*) \- \\ + @^* \\ @^* \- \nlret @^*} \end{describe} @@ -170,14 +175,16 @@ These symbols are defined in the @|sod-utilities| package. {maybe-print-unreadable-object (@ @ @[[ :type @ @! :identity @ @]]) \\ \ind - @^*} + @^* \\ + @^*} \end{describe} \begin{describe}{mac} {dosequence (@ @ @[[ :start @ @! :end @ @! :indexvar @ @]]) \\ \ind - @{ @ @! @ @}^*} + @^* \\ + @{ @ @! @ @}^*} \end{describe} \begin{describe}{mac} @@ -187,12 +194,13 @@ These symbols are defined in the @|sod-utilities| package. \begin{describe}{mac} {default-slot (@ @ @[@@]) \\ \ind - @^*} + @^*} \end{describe} \begin{describe}{mac} {define-on-demand-slot @ @ (@) \\ \ind - @^*} + @[[ @^* @! @ @]] \\ + @^*} \end{describe} %%%-------------------------------------------------------------------------- @@ -307,15 +315,16 @@ These symbols are defined in the @!optparse| package. \begin{describe}{fun}{option-parse-next @} \end{describe} -\begin{describe}{mac}{option-parse-try @^*} +\begin{describe}{mac}{option-parse-try @^*} \end{describe} -\begin{describe}{mac}{with-unix-error-reporting () @^*} +\begin{describe}{mac}{with-unix-error-reporting () @^*} \end{describe} \begin{describe}{mac} {defopthandler @ (@ @[@@]) @ \\ \ind - @^*} + @[[ @^* @! @ @]] \\ + @^*} \end{describe} \begin{describe}{fun} @@ -349,7 +358,10 @@ These symbols are defined in the @!optparse| package. \begin{describe}{opt}{list \&optional @ \&rest @} \end{describe} -\begin{describe}{mac}{defoptmacro @ @ @^*} +\begin{describe}{mac} + {defoptmacro @ @ \\ \ind + @[[ @^* @! @ @]] \\ + @^*} \end{describe} \begin{describe}{fun}{parse-option-form @} @@ -366,7 +378,8 @@ These symbols are defined in the @!optparse| package. (:opt-arg @) @! \\ @ @! (:tag @) @! (:negated-tag @) @! \\ - @{ (@ @ @^*) @}^* @]]) @}^*} + @{ (@ @ @^*) @}^* + @]]) @}^*} \end{describe} \begin{describe}{fun} @@ -432,13 +445,9 @@ These symbols are defined in the @!optparse| package. \begin{describe*} {\dhead{fun}{p-name @ @> @} - \dhead{fun}{setf (p-name @) @} \dhead{fun}{p-value @ @> @} - \dhead{fun}{setf (p-value @) @} \dhead{fun}{p-type @ @> @} - \dhead{fun}{setf (p-type @) @} \dhead{fun}{p-key @ @> @} - \dhead{fun}{setf (p-key @) @} \dhead{fun}{p-seenp @ @> @} \dhead{fun}{setf (p-seenp @) @}} \end{describe*} @@ -468,7 +477,8 @@ These symbols are defined in the @!optparse| package. \begin{describe}{fun}{pset-map @ @} \end{describe} -\begin{describe}{mac}{with-pset-iterator (@ @) @^*} +\begin{describe}{mac} + {with-pset-iterator (@ @) @^* @^*} \end{describe} \begin{describe}{fun} @@ -499,6 +509,7 @@ These symbols are defined in the @!optparse| package. {default-slot-from-property (@ @ @[@@]) \\ \ind\ind (@ @ @ @[@ @^*@]) \- \\ + @^* \\ @^*} \end{describe}