pldoc

Prolog files

doc_access.pl
doc_colour.pl  -- Source colouring support
doc_html.pl  -- PlDoc HTML backend
cite/3	Emit citations.
doc_file_objects/5	Extracts relevant information for FileSpec from the PlDoc database.
doc_for_file/2	HTTP handler that writes documentation for File as HTML.
doc_for_wiki_file/2	Write HTML for the File containing wiki data.
doc_hide_private/3	Remove the private objects from Objs according to Options.
doc_page_dom/3	Create the complete HTML DOM from the Title and Body.
doc_resources/3	Include required resources (CSS, JS) into the output.
doc_tag_title/2	Title is the name to use for Tag in the generated documentation.
doc_write_html/3	Write HTML for the documentation page DOM using Title to Out.
edit_button/4	Create an edit button for File.
ensure_doc_objects/1	Ensure we have documentation about File.
existing_linked_file/2	True if File is a path to an existing file relative to the current file.
file/3	Create a link to another filename if the file exists.
file/4	Create a link to another filename if the file exists.
file_header/4	Create the file header.
flagref/3	Reference to a Prolog flag.
include/5	Inline FileName.
is_op_type/2	True if Atom is an operator of Type.
is_pi/1	True if Term is a predicate indicator.
mode_anchor_name/2	Get the anchor name for a mode.
module_info/3	Add options module(Name), public(Exports) to OtherOptions if File is a module file.
multifile/2	True if Obj is a multifile predicate.
nopredref/3	Result of name/arity, non-linking predicate indicator.
object_edit_button/4	Create a button for editing Object.
object_footer/4	Call the hook doc_object_footer//2.
object_href/2	HREF is the URL to access Object.
object_name/4	HTML description of documented Obj.
object_page/4	Generate an HTML page describing Obj.
object_page_footer/4	Call the hook doc_object_page_footer//2.
object_ref/4	Create a hyperlink to Object.
object_source_button/4	Create a button for showing the source of Object.
object_synopsis/4	Provide additional information about Obj.
object_tree/5	Render a tree of objects used for navigation.
objects/4	Emit the documentation body.
pred_anchor_name/3	Create an HTML anchor name from Head.
pred_dt/5	Emit the predicate header.
pred_edit_button/4	Create a button for editing the given predicate.
predref/3	Create a reference to a predicate.
predref/4	Create a reference to a predicate.
print_html_head/1	Print the DOCTYPE line.
private/2	True if Obj is not exported from Options.
source_button/4	Add show-source button.
tag/4	Called from \tag(Name, Values) terms produced by doc_wiki.pl.
tags/3	Emit the @tag tags of a description.
term/5	Process the \term element as produced by doc_wiki.pl.
unquote_filespec/2	Translate e.g.
zoom_button/4	Add zoom in/out button to show/hide the private documentation.
doc_is_public_object/1	Hook that allows objects to be displayed with the default public-only view.
doc_htmlsrc.pl  -- HTML source pretty-printer
source_to_html/3	Colourise Prolog source as HTML.
doc_index.pl  -- Create indexes
doc_man.pl  -- Process SWI-Prolog HTML manuals
doc_modes.pl  -- Analyse PlDoc mode declarations
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  -- PlDoc for Prolog extension packs
doc_pack/1	Generate stand-alone documentation for the package Pack.
doc_process.pl  -- Process source documentation
comment_modes/2
doc_clean/1	Clean documentation for Module.
doc_comment/4	True if Comment is the comment describing object.
doc_file_has_comments/1	True if we have loaded comments from Source.
doc_file_name/3	Doc is the name of the file for documenting Source.
is_structured_comment/2	True if Comment is a structured comment that should use Prefixes to extract the plain text using indented_lines/3.
parse_comment/3	True when Comment is a structured comment and Parsed is its parsed representation.
process_comments/3	Processes comments returned by read_term/3 using the comments option.
predicate_summary/2	Provide predicate summaries to the XPCE class prolog_predicate, used by the IDE tools.
doc_register.pl
comment_hook/3	Hook called by the compiler and cross-referencer.
doc_search.pl  -- Search form and reply
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  -- Index the HTML manuals
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.