This module pre-processes the HTML files that constitute the manual such
that we can access the summary documentation of all predicates for usage
in IDE tools.
manual_object(?Object, ?Summary, ?File, ?Class, ?Offset) is nondet- True if Object is documented. Arguments:
- Arguments:
-
Object | - is the object documented, described by a Prolog term.
Defined shapes are:
section(Level, Number, Label, File)
- Name/Arity
- Name//Arity
- Module:Name/Arity
- Module:Name//Arity
- f(Name/Arity
c(Name)
|
Summary | - is a string object providing a summary of object |
File | - is the HTML file in which the object is documented |
Class | - is one of manual or packages |
Offset | - is the character offset at which the DOM element
describing Object appears. This is used by doc_man.pl to
quickly extract the node. |
clean_man_index is det- Clean already loaded manual index.
save_man_index- Create swi('doc/manindex.db'), containing an index into the HTML
manuals for use with help/1 and similar predicates. This predicate
is called during the build process.
check_duplicate_ids- Maintenance utility to check that we do not have duplicate section
identifiers in the documentation.
index_man_directory(+Dir, +Options) is det- Index the HTML directory Dir. Options are:
- class(Class)
- Define category of the found objects.
- symbolic(+Term)
- Symbolic (file search) specification for Dir
Remaining Options are passed to absolute_file_name/3.
index_man_file(+Class, +File) is det
index_man_file(+Class, +File, +Symbolic) is det- Collect the documented objects from the SWI-Prolog manual file
File.
current_man_object(?Object) is nondet
man_object_property(?Object, ?Property) is nondet- True when Property is a property of the given manual object. Defined
properties are:
- summary(-Text)
- Summary text for the object.
- id(ID)
- Return unique id for the text, so we can remove duplicates
doc_object_identifier(+DocObject, -Identifier) is semidet- True when Identifier is the name of DocObject.