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:

Intermediate tree representation for documentation

    PREDICATE

    Usage:doctree_is_empty(R)

    Emptiness test

    • The following properties should hold at call time:
      (nonvar/1)R is currently a term which is not a free variable.
      (doctree/1)Intermediate tree representation for documentation

    PREDICATE

    Usage:is_nonempty_doctree(R)

    Not empty test

    • The following properties should hold at call time:
      (nonvar/1)R is currently a term which is not a free variable.
      (doctree/1)Intermediate tree representation for documentation

    PREDICATE

    Usage:empty_doctree(R)

    Empty

    • The following properties should hold at call time:
      (var/1)R is a free variable.
      (doctree/1)Intermediate tree representation for documentation

    PREDICATE

    Usage:doctree_insert_end(A0,Elem,A)

    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)

    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:

    A link to a document label

      REGTYPE

      Usage:

      An internal label

        PREDICATE
        No further documentation available for this predicate.

        PREDICATE
        No further documentation available for this predicate.

        REGTYPE

        Usage:

        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

          Usage:

          • Call and exit should be compatible with:
            (atm/1)Arg1 is an atom.
            (doctree/1)Intermediate tree representation for documentation
          • The following properties should hold at call time:
            (nonvar/1)Arg1 is currently a term which is not a free variable.
            (nonvar/1)Arg2 is currently a term which is not a free variable.

          PREDICATE

          Usage:

          • Call and exit should be compatible with:
            (atm/1)Arg1 is an atom.
            (doctree/1)Intermediate tree representation for documentation
          • The following properties should hold at call time:
            (nonvar/1)Arg1 is currently a term which is not a free variable.

          PREDICATE
          No further documentation available for this predicate.

          PREDICATE

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

          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)

          Scan and save the references of the doctree

          PREDICATE
          No further documentation available for this predicate.

          PREDICATE

          Usage:doctree_to_rawtext(X,DocSt,Y)

          Y is a simplified raw text representation of the X

          PREDICATE
          No further documentation available for this predicate.

          PREDICATE

          Usage:

          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)

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

            PREDICATE

            Usage:version_string(Version,Str)

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

              PREDICATE

              Usage:insert_show_toc(R0,DocSt,R)

              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.