object

# `xref_diagram(Format)`

- `Format` - Graph language file format

Predicates for generating predicate call cross-referencing diagrams.

Author: Paulo Moura
Version: 2:61:0
Date: 2019-10-22
Compilation flags:
`static, context_switching_calls`
Extends:
`public` entity_diagram(Format)
Uses:
list
logtalk
modules_diagram_support
os
Remarks:
(none)
Inherited public predicates:
all_files/0 all_files/1 all_libraries/0 all_libraries/1 default_option/1 default_options/1 diagram_description/1 diagram_name_suffix/1 directories/2 directories/3 directory/1 directory/2 directory/3 file/1 file/2 files/1 files/2 files/3 format_object/1 libraries/1 libraries/2 libraries/3 library/1 library/2 rdirectory/1 rdirectory/2 rdirectory/3 rlibrary/1 rlibrary/2

- Public predicates

  - `entity/2`

  - `entity/1`

- Protected predicates

- Private predicates

  - `included_predicate_/1`

  - `referenced_predicate_/1`

  - `external_predicate_/1`

- Operators

## Public predicates

### `entity/2`

Creates a diagram for a single entity using the specified options.

Compilation flags:
`static`
Template:
`entity(Entity,Options)`
Mode and number of proofs:
`entity(+entity_identifier,+list(compound))` - `one`

### `entity/1`

Creates a diagram for a single entity using default options.

Compilation flags:
`static`
Template:
`entity(Entity)`
Mode and number of proofs:
`entity(+entity_identifier)` - `one`

## Protected predicates

(no local declarations; see entity ancestors if any)

## Private predicates

### `included_predicate_/1`

Compilation flags:
`dynamic`

### `referenced_predicate_/1`

Compilation flags:
`dynamic`

### `external_predicate_/1`

Compilation flags:
`dynamic`

## Operators

(none)

See also

entity_diagram(Format), inheritance_diagram(Format), uses_diagram(Format)