☰

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

Documentation on exports

REGTYPEbackend_id/1

Usage:backend_id(Id)

Id is a supported backend.

    PREDICATEbackend_ignores_components/1

    Usage:backend_ignores_components(Id)

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

      PREDICATEbackend_alt_format/2

      Usage:backend_alt_format(Id,Ext)

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

        PREDICATEparent_format/2

        Usage:parent_format(Format,Parent)

        Parent is the parent format that will generate the file with Format format.

          REGTYPEdocstate/1
          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).

          PREDICATEdocst_backend/2
          No further documentation available for this predicate.

          PREDICATEdocst_currmod/2
          No further documentation available for this predicate.

          PREDICATEdocst_set_currmod/3
          No further documentation available for this predicate.

          PREDICATEdocst_opts/2
          No further documentation available for this predicate.

          PREDICATEdocst_set_opts/3
          No further documentation available for this predicate.

          PREDICATEdocst_inputfile/2
          No further documentation available for this predicate.

          PREDICATEdocst_pragma/2
          No further documentation available for this predicate.

          PREDICATEdocst_new_no_src/4
          No further documentation available for this predicate.

          PREDICATEdocst_new_with_src/5
          No further documentation available for this predicate.

          PREDICATEdocst_new_sub/3
          No further documentation available for this predicate.

          PREDICATEdocst_opt/2
          No further documentation available for this predicate.

          PREDICATEdocst_currmod_is_main/1
          No further documentation available for this predicate.

          PREDICATEdocst_no_components/1

          Usage:docst_no_components(DocSt)

          DocSt specify an empty list of components

            PREDICATEdocst_modname/2

            Usage:docst_modname(DocSt,ModName)

            ModName is the name of the module that we are documenting.

              PREDICATElabgen_init/1
              No further documentation available for this predicate.

              PREDICATElabgen_clean/1
              No further documentation available for this predicate.

              PREDICATElabgen_get/2
              No further documentation available for this predicate.

              PREDICATEdocst_mvar_lookup/3
              No further documentation available for this predicate.

              PREDICATEdocst_mvar_replace/4
              No further documentation available for this predicate.

              PREDICATEdocst_mvar_get/3
              No further documentation available for this predicate.

              PREDICATEdocst_mdata_clean/1
              No further documentation available for this predicate.

              PREDICATEdocst_mdata_assertz/2
              No further documentation available for this predicate.

              PREDICATEdocst_mdata_save/1
              No further documentation available for this predicate.

              PREDICATEdocst_gdata/3
              No further documentation available for this predicate. The predicate is of type data.

              PREDICATEdocst_gdata_query/2
              No further documentation available for this predicate.

              PREDICATEdocst_gdata_query/3
              No further documentation available for this predicate.

              PREDICATEdocst_gdata_restore/1
              No further documentation available for this predicate.

              PREDICATEdocst_gdata_clean/1
              No further documentation available for this predicate.

              PREDICATEdocst_gvar_save/2
              No further documentation available for this predicate.

              PREDICATEdocst_gvar_restore/2
              No further documentation available for this predicate.

              PREDICATEdocst_has_index/2
              No further documentation available for this predicate.

              PREDICATEall_indices/2
              No further documentation available for this predicate.

              PREDICATEget_doc/4
              No further documentation available for this predicate.

              PREDICATEget_doc_changes/2
              No further documentation available for this predicate.

              PREDICATEget_doc_pred_varnames/2
              No further documentation available for this predicate.

              PREDICATEcustom_doc/2
              No further documentation available for this predicate. The predicate is of type data.

              PREDICATEdoc_assertion_read/9
              No further documentation available for this predicate.

              PREDICATEget_docdecl/4
              No further documentation available for this predicate.

              PREDICATEbind_dict_varnames/1

              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.

                PREDICATEget_mod_doc/3
                No further documentation available for this predicate.

                PREDICATEpred_has_docprop/2
                No further documentation available for this predicate.

                PREDICATEdocst_filetype/2
                No further documentation available for this predicate.

                PREDICATEget_first_loc_for_pred/3
                No further documentation available for this predicate.

                Generated with LPdoc using Ciao