object

# `lgtdoc`

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

Author: Paulo Moura
Version: 5:3:0
Date: 2020-06-26
Compilation flags:
`static, context_switching_calls`
Implements:
`public` lgtdocp
Uses:
list
logtalk
os
type
varlist
Remarks:
(none)
Inherited public predicates:
all/0 all/1 directory/1 directory/2 file/1 file/2 library/1 library/2 option/2 rdirectory/1 rdirectory/2 rlibrary/1 rlibrary/2 set_option/2

- Public predicates

- Protected predicates

- Private predicates

  - `option_/2`

  - `library_entity_/4`

  - `directory_entity_/4`

  - `type_entity_/4`

  - `predicate_entity_/4`

- Operators

## Public predicates

(no local declarations; see entity ancestors if any)

## Protected predicates

(no local declarations; see entity ancestors if any)

## Private predicates

### `option_/2`

Table of option values.

Compilation flags:
`dynamic`
Template:
`option_(Option,Value)`
Mode and number of proofs:
`option_(?atom,?nonvar)` - `zero_or_more`

### `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`

## Operators

(none)