object

lgtdoc

Documenting tool. Generates XML documenting files for loaded entities and for library, directory, entity, and predicate indexes.

Availability:

logtalk_load(lgtdoc(loader))

Author: Paulo Moura

Version: 11:3:0

Date: 2026-03-31

Compilation flags:

static, context_switching_calls

Implements:

public lgtdocp

Imports:

public tool_diagnostics_common

public options

Uses:

date

list

logtalk

os

term_io

type

user

varlist

Remarks:

(none)

Inherited public predicates:

 all/0  all/1  check_option/1  check_options/1  context_summaries/2  default_option/1  default_options/1  diagnostic/2  diagnostic/3  diagnostic_rule/5  diagnostic_rules/1  diagnostic_target/1  diagnostics/2  diagnostics/3  diagnostics_breakdown/2  diagnostics_preflight/2  diagnostics_preflight/3  diagnostics_summary/2  diagnostics_summary/3  diagnostics_tool/5  directories/1  directories/2  directory/1  directory/2  file/1  file/2  files/1  files/2  fix_option/2  fix_options/2  libraries/1  libraries/2  library/1  library/2  merge_options/2  option/2  option/3  rdirectories/1  rdirectories/2  rdirectory/1  rdirectory/2  rlibraries/1  rlibraries/2  rlibrary/1  rlibrary/2  valid_option/1  valid_options/1

Public predicates

(no local declarations; see entity ancestors if any)

Protected predicates

(no local declarations; see entity ancestors if any)

Private predicates

library_entity_/4

Table of documented entities per library.

Compilation flags:

dynamic

Template:

library_entity_(Library,PrimarySortKey,SecondarySortKey,Entity)

Mode and number of proofs:

library_entity_(?atom,?nonvar,?nonvar,?atom) - zero_or_more

---

directory_entity_/4

Table of documented entities per directory.

Compilation flags:

dynamic

Template:

directory_entity_(Directory,PrimarySortKey,SecondarySortKey,Entity)

Mode and number of proofs:

directory_entity_(?atom,?nonvar,?nonvar,?atom) - zero_or_more

---

type_entity_/4

Table of documented entities per type.

Compilation flags:

dynamic

Template:

type_entity_(Type,PrimarySortKey,SecondarySortKey,Entity)

Mode and number of proofs:

type_entity_(?atom,?nonvar,?nonvar,?atom) - zero_or_more

---

predicate_entity_/4

Table of public predicates for all documented entities.

Compilation flags:

dynamic

Template:

predicate_entity_(Predicate,PrimarySortKey,SecondarySortKey,Entity)

Mode and number of proofs:

predicate_entity_(?predicate_indicator,?nonvar,?nonvar,?entity_identifier) - zero_or_more

---

cached_run_/5

Cache of diagnostics collected while generating documentation for a target and merged options.

Compilation flags:

dynamic

Template:

cached_run_(Target,Options,Contexts,Diagnostics,PreflightIssues)

Mode and number of proofs:

cached_run_(?nonvar,?list(compound),?list(compound),?list(compound),?list(compound)) - zero_or_more

---

active_diagnostic_/1

Diagnostics collected during the current documentation run.

Compilation flags:

dynamic

Template:

active_diagnostic_(Diagnostic)

Mode and number of proofs:

active_diagnostic_(?compound) - zero_or_more

---

active_preflight_issue_/1

Preflight issues collected during the current documentation run.

Compilation flags:

dynamic

Template:

active_preflight_issue_(Issue)

Mode and number of proofs:

active_preflight_issue_(?compound) - zero_or_more

---

active_collection_mode_/1

Current diagnostics collection mode.

Compilation flags:

dynamic

Template:

active_collection_mode_(Mode)

Mode and number of proofs:

active_collection_mode_(?atom) - zero_or_one

---

Operators

(none)