☰

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.

Documentation on exports

PREDICATEcmd_type/1
No further documentation available for this predicate.

REGTYPEdoctree/1

Usage:

Intermediate tree representation for documentation

    PREDICATEdoctree_is_empty/1

    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

    PREDICATEis_nonempty_doctree/1

    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

    PREDICATEempty_doctree/1

    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

    PREDICATEdoctree_insert_end/3

    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

    PREDICATEdoctree_insert_before_subfile_section/3

    Usage:doctree_insert_before_subfile_section(A0,Elem,A)

    Insert Elem in A0 before the first section, obtaining A. Keep A0 if Elem is already present.

    • 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

    PREDICATEdoctree_concat/3
    No further documentation available for this predicate.

    REGTYPEdoclink/1

    Usage:

    A link to a document label

      REGTYPEdoclabel/1

      Usage:

      An internal label

        PREDICATEdoclink_at/2
        No further documentation available for this predicate.

        PREDICATEdoclink_is_local/1
        No further documentation available for this predicate.

        REGTYPEdoctokens/1

        Usage:

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

          PREDICATEsection_prop/2
          No further documentation available for this predicate.

          PREDICATEsection_select_prop/3
          No further documentation available for this predicate.

          PREDICATEdoctree_save/2

          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.

          PREDICATEdoctree_restore/2

          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.

          PREDICATEdoctree_simplify/2
          No further documentation available for this predicate.

          PREDICATEdoctree_putvars/5

          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

          PREDICATEdoctree_scan_and_save_refs/2

          Usage:doctree_scan_and_save_refs(R,DocSt)

          Scan and save the references of the doctree

          PREDICATEdoctree_prepare_docst_translate_and_write/3
          No further documentation available for this predicate.

          PREDICATEdoctree_to_rawtext/3

          Usage:doctree_to_rawtext(X,DocSt,Y)

          Y is a simplified raw text representation of the X

          PREDICATEdoctree_translate_and_write/3
          No further documentation available for this predicate.

          PREDICATEescape_string/4

          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).

          PREDICATEis_version/1
          No further documentation available for this predicate.

          PREDICATEversion_patch/2
          No further documentation available for this predicate.

          PREDICATEversion_date/2
          No further documentation available for this predicate.

          PREDICATEversion_numstr/2

          Usage:version_numstr(Version,Str)

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

            PREDICATEversion_string/2

            Usage:version_string(Version,Str)

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

              PREDICATEparse_changelog_version/3
              No further documentation available for this predicate.

              PREDICATEinsert_show_toc/3

              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

                PREDICATEdoc_cmd_type/1
                No further documentation available for this predicate. The predicate is multifile.

                PREDICATEdoc_cmd_rw/2
                No further documentation available for this predicate. The predicate is multifile.

                PREDICATEautodoc_rw_command_hook/4
                No further documentation available for this predicate. The predicate is multifile.

                PREDICATEautodoc_escape_string_hook/5
                No further documentation available for this predicate. The predicate is multifile.

                Generated with LPdoc using Ciao