Event-macro-xdoc-constructors-user-level
Utilities to construct XDOC strings
to document event macros
at the user level.
The xdoc::evmac-section-... utilities construct level-3 sections.
Some are relatively thin wrappers,
which precede their arguments
(which must be zero or more pieces of XDOC text)
with specific level-3 headings.
Other utilities provide more automation.
The xdoc::evmac-input-... utilities construct
descriptions
of inputs that are expected to be common to multiple event macros.
Each such utility includes zero or more parameters
to customize the description,
as well as zero or more additional pieces of XDOC text (e.g. paragraphs)
that are appended after the automatically generated XDOC text.
Subtopics
- Xdoc::evmac-desc-function/lambda/macro
- Construct a common description text for an input that must be
a function name or a lambda expression or a macro name.
- Xdoc::evmac-desc-term
- Construct a common description text for an input that must be a term.
- Xdoc::evmac-topic-design-notes
- Generate an XDOC topic for the design notes of an event macro.
- Xdoc::evmac-appcond
- Construct an applicability condition description
in the user documentation of an event macro.
- Xdoc::evmac-desc-input-name
- Construct a description of a :...-name input
for the user documentation of an event macro.
- Xdoc::evmac-section-redundancy
- Construct the redundancy section
of the user documentation of an event macro.
- Xdoc::evmac-input-show-only
- Construct a description of the :show-only input
for the user documentation of an event macro.
- Xdoc::evmac-input-print
- Construct a description of the :print input
for the user documentation of an event macro.
- Xdoc::evmac-desc-input-enable-t/nil
- Construct a description of a :...-enable input
for the user documentation of an event macro.
- Xdoc::evmac-section-appconds
- Construct the applicability conditions section
of the user documentation of an event macro.
- Xdoc::evmac-input-hints
- Construct a description of the :hints input
for the user documentation of an event macro.
- Xdoc::evmac-subsubsubsection
- Construct a subsubsubsection
of the user documentation of an event macro.
- Xdoc::evmac-subsubsection
- Construct a subsubsection
of the user documentation of an event macro.
- Xdoc::evmac-subsection
- Construct a subsection
of the user documentation of an event macro.
- Xdoc::evmac-section
- Construct a section
of the user documentation of an event macro.
- Xdoc::evmac-section-intro
- Construct the introduction section
of the user documentation of an event macro.
- Xdoc::evmac-section-inputs
- Construct the inputs section
of the user documentation of an event macro.
- Xdoc::evmac-section-generated
- Construct the generated events section
of the user documentation of an event macro.
- Xdoc::evmac-section-form
- Construct the general form section
of the user documentation of an event macro.
