object

# `xref_diagram(Format)`

- `Format` - Graph language file format.

Predicates for generating predicate call cross-referencing diagrams.

Availability:
`logtalk_load(diagrams(loader))`
Author: Paulo Moura
Version: 2:85:0
Date: 2024-12-04
Compilation flags:
`static, context_switching_calls`
Extends:
`public` entity_diagram(Format)
Uses:
atom
list
logtalk
modules_diagram_support
os
user
Remarks:
(none)
Inherited public predicates:
all_files/0 all_files/1 all_libraries/0 all_libraries/1 check_option/1 check_options/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 option/2 option/3 rdirectory/1 rdirectory/2 rdirectory/3 rlibrary/1 rlibrary/2 valid_option/1 valid_options/1

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

Table of predicates already included in the diagram for the entity under processing.

Compilation flags:
`dynamic`
Template:
`included_predicate_(Predicate)`
Mode and number of proofs:
`included_predicate_(?predicate_indicator)` - `zero_or_more`

### `referenced_predicate_/1`

Table of referenced predicates for the entity under processing.

Compilation flags:
`dynamic`
Template:
`referenced_predicate_(Predicate)`
Mode and number of proofs:
`referenced_predicate_(?predicate_indicator)` - `zero_or_more`

### `external_predicate_/1`

Table of external predicate references for all the entities under processing.

Compilation flags:
`dynamic`
Template:
`external_predicate_(Reference)`
Mode and number of proofs:
`external_predicate_(?compound)` - `zero_or_more`

## Operators

(none)

See also

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