object

# `entity_diagram(Format)`

- `Format` - Graph language file format.

Predicates for generating entity diagrams in the specified format with both inheritance and cross-referencing relation edges.

Availability:
`logtalk_load(diagrams(loader))`
Author: Paulo Moura
Version: 2:60:0
Date: 2024-12-04
Compilation flags:
`static, context_switching_calls`
Imports:
`public` diagram(Format)
Uses:
list
logtalk
modules_diagram_support
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 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

### `file/2`

Creates a diagram for all entities in a loaded source file using the specified options. The file can be specified by name, basename, full path, or using library notation.

Compilation flags:
`static`
Template:
`file(File,Options)`
Mode and number of proofs:
`file(+atom,+list(compound))` - `one`

### `file/1`

Creates a diagram for all entities in a loaded source file using default options. The file can be specified by name, basename, full path, or using library notation.

Compilation flags:
`static`
Template:
`file(File)`
Mode and number of proofs:
`file(+atom)` - `one`

## Protected predicates

(no local declarations; see entity ancestors if any)

## Private predicates

### `included_entity_/1`

Table of Logtalk entities already included in the diagram.

Compilation flags:
`dynamic`
Template:
`included_entity_(Entity)`
Mode and number of proofs:
`included_entity_(?entity_identifier)` - `zero_or_more`

### `included_module_/1`

Table of Prolog modules already included in the diagram.

Compilation flags:
`dynamic`
Template:
`included_module_(Module)`
Mode and number of proofs:
`included_module_(?module_identifier)` - `zero_or_more`

### `referenced_entity_/2`

Table of referenced Logtalk entities in the diagram.

Compilation flags:
`dynamic`
Template:
`referenced_entity_(Referencer,Entity)`
Mode and number of proofs:
`referenced_entity_(?entity_identifier,?entity_identifier)` - `zero_or_more`

### `referenced_module_/2`

Table of referenced Logtalk entities in the diagram.

Compilation flags:
`dynamic`
Template:
`referenced_module_(Referencer,Entity)`
Mode and number of proofs:
`referenced_module_(?entity_identifier,?module_identifier)` - `zero_or_more`

## Operators

(none)

See also

inheritance_diagram(Format), uses_diagram(Format), xref_diagram(Format), library_diagram(Format)