object

# `entity_diagram(Format)`

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

Author: Paulo Moura
Version: 2.46
Date: 2019/5/3
Compilation flags:
`static, context_switching_calls`
Imports:
`public` diagram(Format)

## Public interface

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

(see related entities)

## Private predicates

### `included_entity_/1`

Compilation flags:
`dynamic`

### `included_module_/1`

Compilation flags:
`dynamic`

### `referenced_entity_/2`

Compilation flags:
`dynamic`

### `referenced_module_/2`

Compilation flags:
`dynamic`

## Operators

(none)

## Remarks

(none)

See also

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