category

library_diagram(Format)

  • Format - Graph language file format.

Common predicates for generating library diagrams.

Availability:
logtalk_load(diagrams(loader))
Author: Paulo Moura
Version: 2:17:0
Date: 2024-12-04
Compilation flags:
static
Extends:
public diagram(Format)
Uses:
list
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

(no local declarations; see entity ancestors if any)

Protected predicates

add_library_documentation_url/4

Adds a documentation URL when using the option url_prefixes/2.

Compilation flags:
static
Template:
add_library_documentation_url(Kind,Options,Library,NodeOptions)
Mode and number of proofs:
add_library_documentation_url(+atom,+list(compound),+atom,-list(compound)) - one

remember_included_library/2

Remember included Logtalk library in the diagram.

Compilation flags:
static
Template:
remember_included_library(Library,Path)
Mode and number of proofs:
remember_included_library(+atom,+atom) - one

remember_referenced_logtalk_library/2

Remember referenced Logtalk library in the diagram.

Compilation flags:
static
Template:
remember_referenced_logtalk_library(Library,Path)
Mode and number of proofs:
remember_referenced_logtalk_library(+atom,+atom) - one

remember_referenced_prolog_library/2

Remember referenced Prolog library in the diagram.

Compilation flags:
static
Template:
remember_referenced_prolog_library(Library,Path)
Mode and number of proofs:
remember_referenced_prolog_library(+atom,+atom) - one

Private predicates

included_library_/2

Table of Logtalk libraries already included in the diagram.

Compilation flags:
dynamic
Template:
included_library_(Library,Path)
Mode and number of proofs:
included_library_(?atom,?atom) - zero_or_more

referenced_logtalk_library_/2

Table of referenced Logtalk libraries in the diagram.

Compilation flags:
dynamic
Template:
referenced_logtalk_library_(Library,Path)
Mode and number of proofs:
referenced_logtalk_library_(?atom,?atom) - zero_or_more

referenced_prolog_library_/2

Table of referenced Prolog libraries in the diagram.

Compilation flags:
dynamic
Template:
referenced_prolog_library_(Library,Path)
Mode and number of proofs:
referenced_prolog_library_(?atom,?atom) - zero_or_more

Operators

(none)

See also

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