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

Auxiliary Definitions

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

Usage and interface

Library usage:
:- use_module(lpdoc(autodoc_aux)).
Exports:
- Predicates:
  all_vars/1, read_file/2, ascii_blank_lines/2, autodoc_process_call/3, cmd_logbase/3, verbose_message/1, verbose_message/2.
Imports:
- Application modules:
  autodoc_settings, autodoc_filesystem.
- System library modules:
  messages, system, system_extra, logged_process, pathnames, format.
- 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, condcomp, assertions, regtypes, basicmodes, fsyntax.

Documentation on exports

PREDICATE

No further documentation available for this predicate.

PREDICATE

No further documentation available for this predicate.

PREDICATE

ascii_blank_lines/2:

No further documentation available for this predicate.

PREDICATE

autodoc_process_call/3:

No further documentation available for this predicate.

PREDICATE

No further documentation available for this predicate.

PREDICATE

verbose_message/1:

No further documentation available for this predicate.

PREDICATE

verbose_message/2:

Usage:verbose_message(Text,ArgList)

The text provided in Text is printed as a message, using the arguments in ArgList, if autodoc_option('-v') is defined. Otherwise nothing is printed.

The following properties should hold at call time:
(format_control/1)Text is an atom or string describing how the arguments should be formatted. If it is an atom it will be converted into a string with name/2.
(list/1)ArgList is a list.