Internal State for Documentation Generation

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

This module defines the internal state of the documentation generation (for a single module).

Usage and interface

Documentation on exports

PROPERTY

Usage: supported_option(Option)

  • Description: Option is a supported documentation option.

PREDICATE

Usage: option_comment(Option,Text)

  • Description: Option is a documentation option which is supported. Text describes the effect of selecting that option. Currently supported options are:

    option_comment(verbose,"Verbose output (good for debugging).        ").
    option_comment(no_bugs,"Do not include information on bugs.         ").
    option_comment(no_authors,"Do not include author names.                ").
    option_comment(no_stability,"Do not include stability comment.           ").
    option_comment(no_version,"Do not include version information.         ").
    option_comment(no_versioned_output,"Do not include version in the output name.  ").
    option_comment(no_changelog,"Do not include change log.                  ").
    option_comment(no_patches,"Do not include comments for patches.        ").
    option_comment(modes,"Do not translate modes and their arguments
    	                        (except for properties)                     ").
    option_comment(head_props,"Do not move head properties to body.        ").
    option_comment(literal_props,"Do not use text to document properties.     ").
    option_comment(no_propnames,"Do not include property names in prop text. ").
    option_comment(no_undefined,"Do not signal undefined properties in text. ").
    option_comment(no_propsepln,"Do not put each property in a separate line.").
    option_comment(no_biblio,"Do not include a bibliographical 'References' appendix.").
    option_comment(no_sysmods,"Do not include system modules in list of 
                                    libraries used.").
    option_comment(no_engmods,"Do not include system engine modules in list 
                                    of libraries used.").
    option_comment(no_isoline,"Do not include *textual* description that a 
                                    given usage conforms to the ISO standard.").
    option_comment(propmods,"Include module name to which props belong.").
    option_comment(no_propuses,"Do not Include property uses (from assertions) in indices.").
    option_comment(shorttoc,"Produce shorter table of contents (no entries
                                    for individual defs of preds, props, etc.).").
    option_comment(regtype_props,"Include in the doc for regtypes the global
                                    prop stating that they are indeed regtypes.").
    option_comment(onesided,"For printing on one side (default is two).").
    option_comment(no_math,"Disable mathematical environments.").
    
  • The following properties should hold upon exit:
    (supported_option/1)Option is a supported documentation option.
    (string/1)Text is a string (a list of character codes).

REGTYPE

Usage: backend_id(Id)

  • Description: Id is a supported backend.

PREDICATE

Usage: backend_ignores_components(Id)

  • Description: Id does not take into account components (only documents the mainfile)

PREDICATE

Usage: backend_alt_format(Id,Ext)

  • Description: Ext is an alternative file format that can be generated by the backend Id

PREDICATE

Usage: top_suffix(FileFormat,PrincipalExt)

  • Description: PrincipalExt is extension of the target file that will generate the file with FileFormat extension.

REGTYPE
A regular type, defined as follows:
docstate(docstate(Backend,Name,Opts,MVarDic,I)) :-
        backend_id(Backend),
        atom(Name),
        list(Opts,supported_option),
        dictionary(MVarDic),
        filename(I).

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
No further documentation available for this predicate.

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
No further documentation available for this predicate.

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
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: docst_no_components(DocSt)

  • Description: DocSt specify an empty list of components

PREDICATE

Usage: docst_modname(DocSt,ModName)

  • Description: ModName is the name of the module that we are documenting.

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
No further documentation available for this predicate.

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
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.
The predicate is of type data.

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
No further documentation available for this predicate.

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
No further documentation available for this predicate.

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: bind_dict_varnames(Dict)

  • Description: Binds the variables in Dict to the corresponding names (i.e., the names that appeared in the source during read.

PREDICATE
No further documentation available for this predicate.

REGTYPE
modtype(part).
modtype(application).
modtype(documentation).
modtype(module).
modtype(user).
modtype(include).
modtype(package).

Usage:

  • Description: Represents the type of file being documented.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.