with a header line, showing a synopsis of the symbol on the left, and the
category (function, class, macro, etc.) on the right.
-\begin{describe}{fun}{example-function @<required>
+\begin{describe*}{\dhead*{fun}{example-function @<required>}
\&optional @<optional>
\&rest @<rest>
\&key :keyword
some-generic-function ((@<specialized> list) @<unspecialized>)
@> @<result>
\end{quote}
-\end{describe}
-
-\begin{describe}{mac}
- {example-macro
- (@{ @<symbol> @! (@<symbol> @<form>) @}^*) \\ \ind
- @[[ @<declaration>^* @! @<doc-string> @]] \\
- @<form>^*
- \nlret @<value>^*}
+\end{describe*}
+
+\begin{describe*}
+ {\dhead*{mac}
+ {example-macro
+ (@{ @<symbol> @! (@<symbol> @<form>) @}^*) \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*
+ \nlret @<value>^*}}
The synopsis for a macro describes the acceptable syntax using the
following notation.
\begin{itemize}
\end{itemize}
For example, the notation at the head of this example describes syntax
for @|let|.
-\end{describe}
+\end{describe*}
-\begin{describe}{cls}{example-class (direct-super other-direct-super) \&key
- :initarg}
+\begin{describe*}
+ {\dhead*{cls}{example-class (direct-super other-direct-super)
+ \&key :initarg}}
The synopsis for a class lists the class's direct superclasses, and the
acceptable initargs in the form of a lambda-list. The initargs may be
passed to @|make-instance| when constructing an instance of the class or a
may also be passed to @|reinitialize-instance| and/or @|change-class| as
applicable; the class description will state explicitly when these
operations are allowed.
-\end{describe}
+\end{describe*}
%%%----- That's all, folks --------------------------------------------------