Based on the report created by the first stage of the Declt pipeline,
the exact contents of the upcoming reference manual can be further
adjusted thanks to the following options. They are passed along to the
assemble function (see Assembly), along with the library’s
report.
:declt-notice ¶Controls the output of a small paragraph about automatic manual
generation by Declt. Possible values are nil (meaning don’t
acknowledge Declt), :short, and :long (the
default). A :short paragraph advertises Declt with its
version number. A :long one also prints its release code name and
the generation time. I would be grateful if you kept at least the short
version in your manuals, as an acknowledgment for using Declt.
:locations ¶Whether to hyperlink definitions to their locations. It defaults to
nil. A value of :file-system means to create hyperlinks on the
local machine, on which Declt is currently being run. These links
being completely specific to the current installation, it is better to
avoid this option if the reference manual is meant to be put online.
:default-values ¶Whether to document standard / default values. The default is nil.
Otherwise, Declt will explicitly mention properties that do not
differ from their default or standard value, such as a standard
method combination, an :instance slot allocation, etc.
:foreign-definitions ¶Whether to include foreign definitions in the documentation. It defaults
to nil, in which case foreign references are still advertised, but do
not point to actual definitions (they are not “clickable”). Otherwise,
only foreign definitions somehow related to the library are considered
for inclusion, and they will most of the time be partial rather than
exhaustive: only the bits relevant to the library are documented. For
more information on foreign definitions, see Domesticity.