Documentation generation library

Author(s): Manuel Hermenegildo, Jose F. Morales.

This library provides some predicates which generate documentation automatically for a given documenation component (module, package, application, etc.), using the declarations and assertions used in the source itself as input (see the assertions library).

The output format in which the documentation is generated is defined by the backend modules (autodoc_texinfo, autodoc_html, autodoc_man, etc.).

Usage and interface

Library usage:
:- use_module(lpdoc(autodoc)).
Exports:
- Predicates:
  reset_output_dir_db/0, ensure_output_dir_prepared/2, get_autodoc_opts/3, autodoc_gen_doctree/5, fmt_infodir_entry/3, autodoc_compute_grefs/3, autodoc_translate_doctree/3, autodoc_is_operational/2, autodoc_finish/1, autodoc_gen_alternative/2.
- Multifiles:
  autodoc_is_operational_hook/2, autodoc_finish_hook/1, autodoc_gen_alternative_hook/2.

Documentation on exports

PREDICATEreset_output_dir_db/0

No further documentation available for this predicate.

PREDICATEensure_output_dir_prepared/2

Usage:ensure_output_dir_prepared(Backend,Opts)

Ensure that the output directories for backend Backend are prepared.

PREDICATEget_autodoc_opts/3

Usage:get_autodoc_opts(Backend,Mod,Opts)

Get the list of documentation options Opts for the FileBase file.

The following properties should hold at call time:
(atm/1)Backend is an atom.
(atm/1)Mod is an atom.
(term/1)Opts is any term.
The following properties should hold upon exit:
(atm/1)Backend is an atom.
(atm/1)Mod is an atom.
(list/2)Opts is a list of supported_options.

PREDICATEautodoc_gen_doctree/5

Usage:autodoc_gen_doctree(Backend,FileBase,FileExt,Opts,Mod)

FileBase is the module specifier of the source file being documented (without extension, FileExt is the source extension). The output is a file whose contents document the main file, based on any assertions present in that file. The documentation is produced in the format given by Backend (the name of the output file also depends on Backend). The formats supported are given by backend_id/1.

Call and exit should be compatible with:
(backend_id/1)Backend is a supported backend.
(filename_noext/1)FileBase is the base name of a file (without extension).
(atm/1)FileExt is an atom.
(list/2)Opts is a list of supported_options.
(atm/1)Mod is an atom.

PREDICATEfmt_infodir_entry/3

Usage:fmt_infodir_entry(DocSt,Version,Mod)

Generates a one line description (ASCII) of the application or library in a file for the directory of emacs info manuals.

The following properties should hold at call time:
(docstate/1)docstate(DocSt)
(term/1)Version is any term.
(filename_noext/1)Mod is the base name of a file (without extension).