object

# lgtdoc

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

author:
  `Paulo Moura`
version:
  `3.2`
date:
  `2016/5/13`

compilation flags:
  `static, context_switching_calls`

implements:
  `public lgtdocp`

## Public interface

(see related entities)

## Protected interface

(see related entities)

## Private predicates

### option_/2

> Table of option values.

compilation flags:
  `dynamic`
template:
  `option_(Option,Value)`
mode – number of proofs:
  `option_(?atom,?nonvar) – zero_or_more`

### directory_entity_/4

> Table of documented entities per directory.

compilation flags:
  `dynamic`
template:
  `directory_entity_(Directory,PrimarySortKey,SecondarySortKey,Entity)`
mode – 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 – 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 – number of proofs:
  `predicate_entity_(?predicate_indicator,?nonvar,?nonvar,?entity_identifier) – zero_or_more`

## Operators

### (none)

## Remarks

### (none)

## See also

### (none)