doc/: Document where declarations are permitted in macros.

[sod] / doc / misc.tex
diff --git a/doc/misc.tex b/doc/misc.tex

index de62c8eace46e40f41d748fc499ade16a82d3d8a..92223d13e5c1e80495f683de713cf981d757ca16 100644 (file)
--- a/doc/misc.tex
+++ b/doc/misc.tex
@@ -32,17 +32,20 @@ These symbols are defined in the @|sod-utilities| package.
  
  \begin{describe}{mac}
      {with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
-      @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{mac}
      {once-only (@[[ :environment @<env> @]]
                  @{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
-      @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{mac}
-    {parse-body @<body> @> @<doc-string> @<declarations> @<body-forms>}
+    {parse-body @<body> \&key :docp :declp
+      @> @<doc-string> @<declarations> @<body-forms>}
  \end{describe}
  
  \begin{describe}{cls}{loc}
@@ -51,7 +54,7 @@ These symbols are defined in the @|sod-utilities| package.
  \begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
  \end{describe}
  
-\begin{describe}{macro}{locf @<place> @> @<locative>}
+\begin{describe}{mac}{locf @<place> @> @<locative>}
  \end{describe}
  
  \begin{describe*}
@@ -63,7 +66,8 @@ These symbols are defined in the @|sod-utilities| package.
      {with-locatives
          @{ @<var> @! (@{ @<var> @!
                           (@<var> @[@<locative>@]) @}^*) @} \\ \ind
-      @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{sym}{it}
@@ -72,7 +76,7 @@ These symbols are defined in the @|sod-utilities| package.
  \begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
  \end{describe}
  
-\begin{describe}{mac}{awhen @<condition> @<body-form>^*}
+\begin{describe}{mac}{awhen @<condition> @<form>^*}
  \end{describe}
  
  \begin{describe}{mac}{acond @{ (@<condition> @<form>^*) @}^*}
@@ -136,7 +140,8 @@ These symbols are defined in the @|sod-utilities| package.
      {categorize (\=@<item-var> @<items>
                     @[[ :bind (@{ @<var> @! (@<var> @[@<value>@]) @}^*) @]])
                                                                   \\ \ind\ind
-        (@{ @<cat-var> @<cat-predicate> @}^*) \- \\
+        (@{ (@<cat-var> @<cat-predicate>) @}^*) \- \\
+      @<declaration>^* \\
        @<body-form>^* \-
       \nlret @<value>^*}
  \end{describe}
@@ -170,14 +175,16 @@ These symbols are defined in the @|sod-utilities| package.
      {maybe-print-unreadable-object (@<object> @<stream>
                                      @[[ :type @<type> @!
                                          :identity @<identity> @]]) \\ \ind
-       @<body-form>^*}
+      @<declaration>^* \\
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{mac}
      {dosequence (@<var> @<sequence>
                   @[[ :start @<start> @! :end @<end> @!
                       :indexvar @<var> @]]) \\ \ind
-      @{ @<tag> @! @<body-form> @}^*}
+      @<declaration>^* \\
+      @{ @<tag> @! @<statement> @}^*}
  \end{describe}
  
  \begin{describe}{mac}
@@ -187,12 +194,13 @@ These symbols are defined in the @|sod-utilities| package.
  
  \begin{describe}{mac}
      {default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
-      @<body-form>^*}
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{mac}
      {define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
-      @<body-form>^*}
+      @[[ @<declaration>^* @! @<doc-string> @]] \\
+      @<form>^*}
  \end{describe}
  
  %%%--------------------------------------------------------------------------
@@ -307,15 +315,16 @@ These symbols are defined in the @!optparse| package.
  \begin{describe}{fun}{option-parse-next @<option-parser>}
  \end{describe}
  
-\begin{describe}{mac}{option-parse-try @<body-form>^*}
+\begin{describe}{mac}{option-parse-try @<form>^*}
  \end{describe}
  
-\begin{describe}{mac}{with-unix-error-reporting () @<body-form>^*}
+\begin{describe}{mac}{with-unix-error-reporting () @<form>^*}
  \end{describe}
  
  \begin{describe}{mac}
      {defopthandler @<name> (@<var> @[@<arg>@]) @<lambda-list> \\ \ind
-      @<body-form>^*}
+      @[[ @<declaration>^* @! @<doc-string> @]] \\
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{fun}
@@ -349,7 +358,10 @@ These symbols are defined in the @!optparse| package.
  \begin{describe}{opt}{list \&optional @<handler> \&rest @<handler-args>}
  \end{describe}
  
-\begin{describe}{mac}{defoptmacro @<name> @<lambda-list> @<body-form>^*}
+\begin{describe}{mac}
+    {defoptmacro @<name> @<lambda-list> \\ \ind
+      @[[ @<declaration>^* @! @<doc-string> @]] \\
+      @<form>^*}
  \end{describe}
  
  \begin{describe}{fun}{parse-option-form @<form>}
@@ -366,7 +378,8 @@ These symbols are defined in the @!optparse| package.
                           (:opt-arg @<arg-name>) @! \\
                           @<keyword> @! (:tag @<tag>) @!
                                         (:negated-tag @<tag>) @! \\
-                         @{ (@<handler> @<var> @<handler-arg>^*) @}^* @]]) @}^*}
+                         @{ (@<handler> @<var> @<handler-arg>^*) @}^*
+                   @]]) @}^*}
  \end{describe}
  
  \begin{describe}{fun}
@@ -468,7 +481,8 @@ These symbols are defined in the @!optparse| package.
  \begin{describe}{fun}{pset-map @<func> @<pset>}
  \end{describe}
  
-\begin{describe}{mac}{with-pset-iterator (@<iter> @<pset>) @<body-form>^*}
+\begin{describe}{mac}
+    {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*}
  \end{describe}
  
  \begin{describe}{fun}
@@ -499,6 +513,7 @@ These symbols are defined in the @!optparse| package.
      {default-slot-from-property
          (@<instance> @<slot> @[@<slot-names>@]) \\ \ind\ind
          (@<pset> @<property> @<type> @[@<prop-var> @<convert-form>^*@]) \- \\
+      @<declaration>^* \\
        @<default-form>^*}
  \end{describe}