pldoc

Prolog files

doc_access.pl
doc_colour.pl  -- Source colouring support
doc_html.pl  -- PlDoc HTML backend
doc_htmlsrc.pl
source_to_html/3	Colourise Prolog source as HTML.
doc_index.pl  -- Create indexes
doc_library.pl  -- BIM compatibility layer
doc_load_library/0	Load the SWI-Prolog library, so we can access all comments from the library.
doc_man.pl  -- Process SWI-Prolog HTML manuals
man_content_tree/2	Compute the content tree for a multi-file HTML document.
man_overview/3	Provide a toplevel overview on the manual: the reference manual and the available packages.
man_packages_tree/1	Tree is the content tree of all packages.
man_page/4	Produce a Prolog manual page for Obj.
man_synopsis/4	Give synopsis details for a fully specified predicate indicator and link this to the section.
doc_object_href/2	Produce a HREF for section objects.
doc_object_link/4	Provide the HTML to describe Obj for linking purposes.
doc_modes.pl
compile_clause/2	Add a clause to the compiled program.
compile_mode/2	Compile a PlDoc mode declararion into a term mode(Head, Determinism).
is_mode/1	True if Head is a valid mode-term.
mode/2	True if there is a mode-declaration for Head with Det.
mode_indicator/1	Our defined argument-mode indicators.
modes_to_predicate_indicators/2	Create a list of predicate indicators represented by Modes.
process_modes/6	Process the formal header lines (upto the first blank line), returning the remaining lines and the names of the arguments used in the various header lines.
doc_pack.pl
doc_pack/1	Generate stand-alone documentation for the package Pack.
doc_process.pl  -- Process source documentation
doc_register.pl
comment_hook/3	Hook called by the compiler and cross-referencer.
doc_search.pl  -- Search form and reply
matching_object_table/4	Show a list of matching objects, similar to a result-set from search.
search_form/3	Create a search input field.
search_reply/4	Generate a reply searching for For.
doc_util.pl  -- PlDoc utilities
atom_pi/2	Translate an external predicate indicator representated as an atom into a predicate indicator term.
atom_to_object/2	If Atom is `Name/Arity', decompose to Name and Arity.
ensure_slash_end/2	Ensure Dir ends with a /.
expand_alias/2	Translate an aliased path to a native path.
insert_alias/2	Translate a native path to an aliased path.
normalise_white_space/3	Text is input after deleting leading and trailing white space and mapping all internal white space to a single space.
doc_wiki.pl  -- PlDoc wiki parser
doc_words.pl  -- Reason about Prolog jargon
man_index.pl
check_duplicate_ids/0	Maintenance utility to check that we do not have duplicate section identifiers in the documentation.
clean_man_index/0	Clean already loaded manual index.
current_man_object/1
doc_object_identifier/2	True when Identifier is the name of DocObject.
index_man_directory/2	Index the HTML directory Dir.
index_man_file/2	Collect the documented objects from the SWI-Prolog manual file File.
man_object_property/2	True when Property is a property of the given manual object.
manual_object/5	True if Object is documented.
save_man_index/0	Create swi('doc/manindex.db'), containing an index into the HTML manuals for use with help/1 and similar predicates.