Documentation Abstract Syntax Tree

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

This module defines the intermediate tree representation doctree/1 for documentation and its related operations.

Note: This part needs better documentation. -- JFMC

Documentation on exports

PREDICATE
No further documentation available for this predicate.

REGTYPE

Usage:

  • Description: Intermediate tree representation for documentation

PREDICATE

Usage: doctree_is_empty(+R)

  • Description: Emptiness test
  • The following properties should hold at call time:
    (doctree/1)Intermediate tree representation for documentation

PREDICATE

Usage: is_nonempty_doctree(+R)

  • Description: Not empty test
  • The following properties should hold at call time:
    (doctree/1)Intermediate tree representation for documentation

PREDICATE

Usage: empty_doctree(-R)

  • Description: Empty
  • The following properties should hold at call time:
    (doctree/1)Intermediate tree representation for documentation

PREDICATE

Usage: doctree_insert_end(A0,Elem,A)

  • Description: Insert Elem in A0 at the end, obtaining A
  • Call and exit should be compatible with:
    (doctree/1)Intermediate tree representation for documentation
    (doctree/1)Intermediate tree representation for documentation
    (doctree/1)Intermediate tree representation for documentation

PREDICATE

Usage: doctree_insert_before_section(A0,Elem,A)

  • Description: Insert Elem in A0 before the first section, obtaining A
  • Call and exit should be compatible with:
    (doctree/1)Intermediate tree representation for documentation
    (doctree/1)Intermediate tree representation for documentation
    (doctree/1)Intermediate tree representation for documentation

PREDICATE
No further documentation available for this predicate.

REGTYPE

Usage:

  • Description: A link to a document label

REGTYPE

Usage:

  • Description: An internal label

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

REGTYPE

Usage:

  • Description: Primitive doctree subset (ready for output, not further reducible)

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: doctree_putvars(R0,DocSt,PDict,VarDict,R)

  • Description: Traverse R0 and replace each var(Name) doctree item with a fresh variable B. For each replacement, the term B=Var is introduced in VarDict, where Var is the associated value to Name in the dictionary PDict.
  • The following properties should hold at call time:
    (doctree/1)Intermediate tree representation for documentation
    (docstate/1)docstate(DocSt)
  • The following properties should hold upon exit:
    (doctree/1)Intermediate tree representation for documentation

PREDICATE

Usage: doctree_scan_and_save_refs(R,DocSt)

  • Description: Scan and save the references of the doctree
  • The following properties should hold at call time:
    (doctree/1)Intermediate tree representation for documentation
    (docstate/1)docstate(DocSt)

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: doctree_to_rawtext(X,DocSt,Y)

  • Description: Y is a simplified raw text representation of the X
  • Call and exit should be compatible with:
    (doctree/1)Intermediate tree representation for documentation
    (docstate/1)docstate(DocSt)
    (string/1)Y is a string (a list of character codes).

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage:

  • Description: Escapes needed characters in input string as needed for the target format.
  • The following properties should hold upon exit:
    (atom/1)Arg1 is currently instantiated to an atom.
    (string/1)Arg2 is a string (a list of character codes).
    (docstate/1)docstate(Arg3)
    (string/1)Arg4 is a string (a list of character codes).

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: version_numstr(Version,Str)

  • Description: Obtain the string Str representation of version Version (except date)

PREDICATE

Usage: version_string(Version,Str)

  • Description: Obtain the string Str representation of version Version (including date)

PREDICATE

Usage: insert_show_toc(R0,DocSt,R)

  • Description: Insert the command to show the table of contents in a given doctree/1. The right place may be different depending on the chosen backend.

Documentation on multifiles

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

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