Download lpdoc Reference Manual - pdf

102
The lpdoc Documentation Generator
OS is the output stream to which writes should be made (normally points to the output
file).
Usage: format_property(Format,Prop,PM,DocString,VarNames,Opts,OS)
− Description: Properties are formatted as running text.
− The following properties should hold at call time:
Format is an atom.
(atm/1)
Prop is any term.
(term/1)
PM is an atom.
(atm/1)
DocString is a string (a list of character codes).
(string/1)
VarNames is a list of strings.
(list/2)
Opts is a list of supported_options.
(list/2)
OS is an open stream.
(stream/1)
format properties end/2:
PREDICATE
format_properties_end(Format,OS)
This predicate defines the end of the description of the properties for a given predicate.
Format is the type of output (e.g., texinfo, latex, etc.). N is the usage number. OS is the
output stream to which writes should be made (normally points to the output file).
Usage: format_properties_end(Format,OS)
− Description: End of the (second level) itemized list.
− The following properties should hold at call time:
Format and texinfo unify.
(= /2)
OS is an open stream.
(stream/1)
format description/3:
PREDICATE
format_description(Format,Desc,OS)
This predicate defines the format of Desc, an introductory text for the predicate (taken
from the comment part of a pred/1 declaration, if available). These coments are generally
used to describe a particular usage of the predicate. Format is the type of output (e.g.,
texinfo, latex, etc.). OS is the output stream to which writes should be made (normally
points to the output file).
Usage: format_description(Format,Desc,OS)
− Description: The description of the usage is a separate item in the site item list.
− The following properties should hold at call time:
Format is currently instantiated to an atom.
(atom/1)
Desc is a string (a list of character codes).
(string/1)
OS is an open stream.
(stream/1)
format other info/10:
No further documentation available for this predicate.
PREDICATE