1.2. @-commands

section.

  ;;@section <string> [<section-id>]
This command starts a new <section> in the generated (S)XML. The first parameter is the title of the new (sub)section, and should be a (double-quoted) string. The second parameter is optional - if present it should be a string or symbol to be used as the "id" attribute of the new section.

variable.

  ;;@variable <varname>
This command overrides the definition this comment is associated with, if any, and forces a variable-definition block to be output.

function.

  ;;@function (<function-name> [<arg> ...])
This command overrides the definition this comment is associated with, if any, and forces a function-definition block to be output. If there is a rest parameter in the list of args, it is output as a regular parameter followed by an ellipsis.

macro.

  ;;@macro (<macro-name> [<arg> ...])
Similar to @function, but documents a macro definition instead of a function definition.

sxml.

  ;;@sxml
Forces the rest of the comment to be interpreted as an SXML fragment to be literally inserted into the SXML output of extract-doc.

title.

  ;;@title <string>
Sets the title of the outermost generated SXML section to the string parameter given, and outputs the rest of the comment as initial paragraphs in the section. Should be used only as the first docscm command in a particular input file.