◄►The lpdoc Documentation Generator » PART II - LPdoc Internals Manual » LPdoc Backends »

HTML Backend

Author(s): Jose F. Morales.

Usage and interface

Library usage:
:- use_module(library(autodoc_html)).
Imports:
- Application modules:
  lpdocsrc(src(autodoc_state)), lpdocsrc(src(autodoc_structure)), lpdocsrc(src(autodoc_filesystem)), lpdocsrc(src(autodoc_doctree)), lpdocsrc(src(autodoc_index)), lpdocsrc(src(autodoc_refsdb)), lpdocsrc(src(autodoc_images)), lpdocsrc(src(autodoc_settings)), lpdocsrc(src(comments)), lpdocsrc(src(autodoc_html_template)), lpdocsrc(src(pbundle_download)), lpdocsrc(src(autodoc_html_resources)).
- System library modules:
  lists, dict, format_to_string, system, file_utils.
- Internal (engine) modules:
  term_basic, arithmetic, atomic_basic, basic_props, basiccontrol, data_facts, exceptions, io_aux, io_basic, prolog_flags, streams_basic, system_info, term_compare, term_typing, hiord_rt, debugger_support.
- Packages:
  prelude, nonpure, assertions, regtypes, fsyntax.

Documentation on multifiles

PREDICATE

autodoc_escape_string_hook/5:

No further documentation available for this predicate. The predicate is multifile.

PREDICATE

autodoc_rw_command_hook/4:

Usage:autodoc_rw_command_hook(Backend,DocSt,Command,NewCommand)

The following properties should hold at call time:
(backend_id/1)Backend is a supported backend.
(docstate/1)docstate(DocSt)
(doctree/1)Intermediate tree representation for documentation
(doctree/1)Intermediate tree representation for documentation

The predicate is multifile.

PREDICATE

autodoc_finish_hook/1:

No further documentation available for this predicate. The predicate is multifile.

PREDICATE

autodoc_gen_alternative_hook/2:

No further documentation available for this predicate. The predicate is multifile.