ON THIS PAGE
Driver for documentation generation
Author(s): Manuel Hermenegildo, Jose F. Morales.
This module implements the main driver for documentation generation.
Usage and interface
- Library usage:
:- use_module(lpdoc(docmaker)). - Exports:
- Predicates:
doc_cmd/3. - Multifiles:
fsmemo.key/2, fsmemo.deps/2, fsmemo.run/1.
- Predicates:
Documentation on exports
PREDICATEdoc_cmd/3
Usage:doc_cmd(InFile,Opts,Cmd)
Treat according to Cmd InFile (which can be a doccfg-file or standalone file). Opts is the list of options (see autodoc_option/1).
Documentation on multifiles
PREDICATEfsmemo.key/2
The predicate is multifile.
Module entry condition:fsmemo.key(Action,Arg2)
- The following properties hold at call time:
(ground/1)Action is currently ground (it contains no variables).
PREDICATEfsmemo.deps/2
The predicate is multifile.
Module entry condition:fsmemo.deps(Action,Arg2)
- The following properties hold at call time:
(ground/1)Action is currently ground (it contains no variables).
PREDICATEfsmemo.run/1
The predicate is multifile.
Module entry condition:fsmemo.run(Action)
- The following properties hold at call time:
(ground/1)Action is currently ground (it contains no variables).
Documentation on imports
This module has the following direct dependencies:- Application modules:
autodoc, autodoc_state, autodoc_images, autodoc_structure, autodoc_settings, autodoc_filesystem, autodoc_texinfo, autodoc_messages, docmod_holder. - System library modules:
format, aggregates, compiler, lists, stream_utils, pathnames, fsmemo_rt, port_reify, system, opendoc, read. - Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basiccontrol, exceptions, term_compare, term_typing, debugger_support, basic_props, hiord_rt, internals, stream_basic. - Packages:
prelude, initial, condcomp, assertions, assertions/assertions_basic, regtypes, dcg, basicmodes, fsyntax, fsmemo.