object

# diagrams(Format)

> Predicates for generating all supported diagrams for libraries, directories, or files in one step using the specified format.

author:
  `Paulo Moura`
version:
  `2.2`
date:
  `2016/4/27`

compilation flags:
  `static, context_switching_calls`

(no dependencies on other files)

## Public interface

### libraries/3

> Creates all supported diagrams for a set of libraries using the specified options.

compilation flags:
  `static`
template:
  `libraries(Project,Libraries,Options)`
mode – number of proofs:
  `libraries(+atom,+list(atom),+list(compound)) – one`

### libraries/2

> Creates all supported diagrams for a set of libraries using the default options.

compilation flags:
  `static`
template:
  `libraries(Project,Libraries)`
mode – number of proofs:
  `libraries(+atom,+list(atom)) – one`

### all_libraries/1

> Creates all supported diagrams for all loaded libraries using the specified options.

compilation flags:
  `static`
template:
  `all_libraries(Options)`
mode – number of proofs:
  `all_libraries(+list(compound)) – one`

### all_libraries/0

> Creates all supported diagrams for all loaded libraries using default options.

compilation flags:
  `static`
mode – number of proofs:
  `all_libraries – one`

### rlibrary/2

> Creates all supported diagrams for a library and its sub-libraries using the specified options.

compilation flags:
  `static`
template:
  `rlibrary(Library,Options)`
mode – number of proofs:
  `rlibrary(+atom,+list(compound)) – one`

### rlibrary/1

> Creates all supported diagrams for a library and its sub-libraries using default options.

compilation flags:
  `static`
template:
  `rlibrary(Library)`
mode – number of proofs:
  `rlibrary(+atom) – one`

### library/2

> Creates all supported diagrams for a library using the specified options.

compilation flags:
  `static`
template:
  `library(Library,Options)`
mode – number of proofs:
  `library(+atom,+list(compound)) – one`

### library/1

> all supported diagrams for a library using default options.

compilation flags:
  `static`
template:
  `library(Library)`
mode – number of proofs:
  `library(+atom) – one`

### directories/3

> Creates all supported diagrams for a set of directories using the specified options.

compilation flags:
  `static`
template:
  `directories(Project,Directories,Options)`
mode – number of proofs:
  `directories(+atom,+list(atom),+list(compound)) – one`

### directories/2

> Creates all supported diagrams for a set of directories using the default options.

compilation flags:
  `static`
template:
  `directories(Project,Directories)`
mode – number of proofs:
  `directories(+atom,+list(atom)) – one`

### directory/3

> Creates all supported diagrams for a directory using the specified options.

compilation flags:
  `static`
template:
  `directory(Project,Directory,Options)`
mode – number of proofs:
  `directory(+atom,+atom,+list(compound)) – one`

### directory/2

> Creates all supported diagrams for a directory using default options.

compilation flags:
  `static`
template:
  `directory(Project,Directory)`
mode – number of proofs:
  `directory(+atom,+atom) – one`

### files/3

> Creates all supported diagrams for a set of files using the specified options. The file can be specified by name, basename, full path, or using library notation.

compilation flags:
  `static`
template:
  `files(Project,Files,Options)`
mode – number of proofs:
  `files(+atom,+list(atom),+list(compound)) – one`

### files/2

> Creates all supported diagrams for a set of files using the default options. The file can be specified by name, basename, full path, or using library notation.

compilation flags:
  `static`
template:
  `files(Project,Files)`
mode – number of proofs:
  `files(+atom,+list(atom)) – one`

### all_files/1

> Creates all supported diagrams for all loaded files using the specified options.

compilation flags:
  `static`
template:
  `all_files(Options)`
mode – number of proofs:
  `all_files(+list(compound)) – one`

### all_files/0

> Creates all supported diagrams for all loaded files using default options.

compilation flags:
  `static`
mode – number of proofs:
  `all_files – one`

## Protected interface

(none)

## Private predicates

(none)

## Operators

### (none)

## Remarks

Common options
  title/1, date/1, output_directory/1, relation_labels/1, node_type_captions/1, exclude_files/1, exclude_libraries/1, url_prefixes/1, omit_path_prefix/1, entity_url_suffix_target/2, and layout/1.

Limitations
  Some of the provided predicates only make sense for some types of diagrams. Also, fine tuning may require generating individual diagrams directly instead of as a batch using this utility object.

## See also

### (none)