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
- Library usage:
:- use_module(library(autodoc_state)). - Exports:
- Predicates:
option_comment/2, backend_ignores_components/1, backend_alt_format/2, top_suffix/2, docst_backend/2, docst_currmod/2, docst_set_currmod/3, docst_opts/2, docst_set_opts/3, docst_inputfile/2, docst_new_no_src/4, docst_new_with_src/6, docst_new_sub/3, docst_message/2, docst_message/3, docst_opt/2, docst_currmod_is_main/1, docst_no_components/1, docst_modname/2, labgen_init/1, labgen_clean/1, labgen_get/2, docst_mvar_lookup/3, docst_mvar_replace/4, docst_mvar_get/3, docst_mdata_clean/1, docst_mdata_assertz/2, docst_mdata_save/1, docst_gdata/3, docst_gdata_query/2, docst_gdata_query/3, docst_gdata_restore/1, docst_gdata_clean/1, docst_gvar_save/2, docst_gvar_restore/2, docst_has_index/2, all_indices/2, get_doc/4, get_doc_changes/3, get_doc_pred_varnames/2, doc_assertion_read/9, bind_dict_varnames/1, get_mod_doc/3, pred_has_docprop/2, docst_modtype/2, get_first_loc_for_pred/3. - Properties:
supported_option/1. - Regular Types:
backend_id/1, docstate/1, modtype/1.
- Predicates:
- Imports:
- Application modules:
lpdocsrc(src(autodoc_settings)), lpdocsrc(src(autodoc_filesystem)), lpdocsrc(src(autodoc_structure)), lpdocsrc(src(autodoc_doctree)), lpdocsrc(src(autodoc_refsdb)), lpdocsrc(src(autodoc_parse)), lpdocsrc(src(autodoc_index)), lpdocsrc(src(comments)), lpdocsrc(src(autodoc_aux)). - System library modules:
make/make_rt, dict, aggregates, compiler/compiler, assertions/assrt_lib, compiler/c_itf, assertions/assertions_props, messages, filenames, lists, terms, system_extra, write, read, system. - 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, dcg, assertions, regtypes, basicmodes, fsyntax.
- Application modules:
Documentation on exports
PROPERTY
Usage:supported_option(Option)
Option is a supported documentation option.
PREDICATE
Usage:option_comment(Option,Text)
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_lpdocack,"Do not include an ack of LPdoc in output."). 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 the import list."). option_comment(no_engmods,"Do not include system engine modules in the import list."). option_comment(no_packages,"Do not include packages in the import list."). 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).
PREDICATE
Usage:backend_ignores_components(Id)
Id does not take into account components (only documents the mainfile)
PREDICATE
Usage:backend_alt_format(Id,Ext)
Ext is an alternative file format that can be generated by the backend Id
PREDICATE
Usage:top_suffix(FileFormat,PrincipalExt)
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
Usage:docst_no_components(DocSt)
DocSt specify an empty list of components
PREDICATE
Usage:docst_modname(DocSt,ModName)
ModName is the name of the module that we are documenting.
PREDICATE
No further documentation available for this predicate.
The predicate is of type data.
PREDICATE
Usage:bind_dict_varnames(Dict)
Binds the variables in Dict to the corresponding names (i.e., the names that appeared in the source during read.
REGTYPE
modtype(part). modtype(application). modtype(documentation). modtype(module). modtype(user). modtype(include). modtype(package).
Usage:
Represents the type of file being documented.
