protocol
Documenting tool protocol.
Paulo Moura
2.0
2014/12/2
static
(no dependencies on other files)
Creates XML documenting files for all entities in a library and its sub-libraries using the specified options.
static
rlibrary(Library,Options)
rlibrary(+atom,+list) – one
Creates XML documenting files for all entities in a library and its sub-libraries using default options.
static
rlibrary(Library)
rlibrary(+atom) – one
Creates XML documenting files for all entities in a library using the specified options.
static
library(Library,Options)
library(+atom,+list) – one
Creates XML documenting files for all entities in a library using default options.
static
library(Library)
library(+atom) – one
Creates XML documenting files for all entities in a loaded source file using the specified options. The file can be given by name, basename, full path, or using library notation.
static
file(File,Options)
file(+atom,+list) – one
Creates XML documenting files for all entities in a loaded source file using default options. The file can be given by name, basename, full path, or using library notation.
static
file(File)
file(+atom) – one
Creates XML documenting files for all loaded entities using the specified options.
static
all(File)
all(+list) – one
Creates XML documenting files for all loaded entities using default options.
static
all – one
Returns, by backtracking, all options and their values.
static
option(Option,Value)
option(?atom,?nonvar) – zero_or_more
Sets an option value.
static
set_option(Option,Value)
set_option(+atom,+nonvar) – zero_or_one
(none)
(none)