protocol
lgtdocp
Documenting tool protocol.
logtalk_load(lgtdoc(loader))static
Compiling files for generating XML documentation: All source files must be compiled with the
source_dataflag turned on.
xml_spec(Specification)option: XML documenting files specification format. Possible option values aredtd(DTD specification; default) andxsd(XML Schema specification).
xml_spec_reference(Reference)option: Reference to the XML specification file in XML documenting files. Possible values arelocal(default; DTD/XSD file in same folder as XML files),web(logtalk.org website DTD/XSD file), andstandalone(no reference to specification files).
entity_xsl_file(File)option: XSLT file to use with generated XML documenting files. Default islogtalk_entity_to_xml.xsl, allowing the XML files to be viewed by opening them with a browser supporting XSLT (after running thelgt2xml.shscript on the output directory).
index_xsl_file(File)option: XSLT file to use with generated XML documenting files. Default islogtalk_index_to_xml.xsl, allowing the XML files to be viewed by opening them with a browser supporting XSLT (after running thelgt2xml.shscript on the output directory).
xml_docs_directory(Directory)option: Directory where the XML documenting files will be generated. The default value is./xml_docs, a sub-directory of the source files directory.
bom(Boolean)option: Defines if a BOM should be added to the generated XML documenting files.
encoding(Encoding)option: Encoding to be used for the generated XML documenting files.
omit_path_prefixes(Prefixes)option: List of path prefixes (atoms) to omit when writing directory paths. The default value is to omit the home directory.
exclude_files(List)option: List of files to exclude when generating the XML documenting files.
exclude_paths(List)option: List of relative library paths to exclude when generating the XML documenting files (default is[]). All sub-directories of the excluded directories are also excluded.
exclude_prefixes(List)option: List of path prefixes to exclude when generating the XML documenting files (default is[]).
exclude_entities(List)option: List of entities to exclude when generating the XML documenting files (default is[]).
sort_predicates(Boolean)option: Sort entity predicates (default isfalse).Known issues: Some options may depend on the used XSL processor. Most XSL processors support DTDs but only some of them support XML Schemas. Some processors (e.g.,
fop2) reject reference to a DTD.
Public predicates
rlibraries/2
Creates XML documenting files for all entities in all given libraries and their sub-libraries using the specified options.
staticrlibraries(Libraries,Options)rlibraries(+list(atom),+list) - onerlibraries/1
Creates XML documenting files for all entities in all given libraries and their sub-libraries using default options.
staticrlibraries(Libraries)rlibraries(+list(atom)) - onerlibrary/2
Creates XML documenting files for all entities in a library and its sub-libraries using the specified options.
staticrlibrary(Library,Options)rlibrary(+atom,+list) - onerlibrary(tools,[xslfile('lgtmd.xsl')])yesrlibrary/1
Creates XML documenting files for all entities in a library and its sub-libraries using default options.
staticrlibrary(Library)rlibrary(+atom) - onelgt2xml script)rlibrary(tools)yeslibraries/2
Creates XML documenting files for all entities in all given libraries using the specified options.
staticlibraries(Libraries,Options)libraries(+list(atom),+list) - onelibraries/1
Creates XML documenting files for all entities in all given libraries using default options.
staticlibraries(Libraries)libraries(+list(atom)) - onelibrary/2
Creates XML documenting files for all entities in a library using the specified options.
staticlibrary(Library,Options)library(+atom,+list) - onelibrary(library,[xslfile('logtalk_entity_to_pdf_a4.xsl')])yeslibrary/1
Creates XML documenting files for all entities in a library using default options.
staticlibrary(Library)library(+atom) - onerdirectories/2
Creates XML documenting files for all entities in all given directories and their sub-directories using the specified options.
staticrdirectories(Directories,Options)rdirectories(+list(atom),+list) - onerdirectories/1
Creates XML documenting files for all entities in all given directories and their sub-directories using default options.
staticrdirectories(Directories)rdirectories(+list(atom)) - onerdirectory/2
Creates XML documenting files for all entities in a directory and its sub-directories using the specified options.
staticrdirectory(Directory,Options)rdirectory(+atom,+list) - onerdirectory('./tools',[xslfile('lgtmd.xsl')])yesrdirectory/1
Creates XML documenting files for all entities in a directory and its sub-directories using default options.
staticrdirectory(Directory)rdirectory(+atom) - onelgt2xml script)rdirectory('./tools')yesdirectories/2
Creates XML documenting files for all entities in all given directories using the specified options.
staticdirectories(Directories,Options)directories(+list(atom),+list) - onedirectories/1
Creates XML documenting files for all entities in all given directories using default options.
staticdirectories(Directories)directories(+list(atom)) - onedirectory/2
Creates XML documenting files for all entities in a directory using the specified options.
staticdirectory(Directory,Options)directory(+atom,+list) - onedirectory('.',[xslfile('logtalk_entity_to_pdf_a4.xsl')])yesdirectory/1
Creates XML documenting files for all entities in a directory using default options.
staticdirectory(Directory)directory(+atom) - onefiles/2
Creates XML documenting files for all entities in loaded source files using the specified options. The files can be given by name, basename, full path, or using library notation.
staticfiles(Files,Options)files(+list(atom),+list) - onefiles/1
Creates XML documenting files for all entities in loaded source files using default options. The files can be given by name, basename, full path, or using library notation.
staticfiles(Files)files(+list(atom)) - onefile/2
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.
staticfile(File,Options)file(+atom,+list) - onefile/1
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.
staticfile(File)file(+atom) - oneall/1
Creates XML documenting files for all loaded entities using the specified options.
staticall(Options)all(+list) - oneall/0
Creates XML documenting files for all loaded entities using default options.
staticall - oneProtected predicates
(none)
Private predicates
(none)
Operators
(none)
See also