Construct a description of a
This is for an input to determine the name of an entity (e.g. a function) generated by the event macro.
The
A description of the entitty whose name is being determined
is passed as the
The
An XDOC tree of additional text can be passed
as the
The
Macro:
(defmacro xdoc::evmac-desc-input-name (prefix &key desc auto-desc additional name-rest) (declare (xargs :guard (and (stringp prefix) (stringp desc) (stringp auto-desc) (stringp name-rest)))) (cons 'xdoc::desc (cons (concatenate 'string "@(':" prefix "-name') — default @(':auto')") (cons (cons 'xdoc::p (cons '"Determines the name of " (cons desc '(".")))) (cons '(xdoc::p "It must be one of the following:") (cons (cons 'xdoc::ul (cons (cons 'xdoc::li (cons '"@(':auto'), to use " (cons auto-desc '(".")))) '((xdoc::li "Any other symbol, to use as the name.")))) (append (and additional (list additional)) (cons (cons 'xdoc::p (cons '"In the rest of this documentation page, let @('" (cons name-rest '("') be this name.")))) 'nil))))))))