PlDoc --- SWI-Prolog source documentation
The pldoc module processes structured comments in Prolog source files.
These comments can be saved to file. During development the
documentation system can start a web-server to view the documentation of
loaded sources through your browser. The server is defined in the file
doc_http.pl and started through doc_server/1.
During development, a typical scenario is to first start the
documentation server and start a browser at http://localhost:4000.
Note that by default the web-pages allow for starting an editor only if
the connection comes from localhost. See doc_server/2 to realise a
different setup.
:- doc_server(4000). :- [application].
Prolog files
doc_access.pl | ||
|---|---|---|
| doc_colour.pl -- Source colouring support | ||
| doc_html.pl -- PlDoc HTML backend | ||
| 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 | ||
| doc_pack.pl -- PlDoc for Prolog extension packs | ||
| doc_process.pl -- Process source documentation | ||
| doc_register.pl | ||
| 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 | ||
| doc_wiki.pl -- PlDoc wiki parser | ||
| autolink_extension/2 | True if Ext is a filename extensions that create automatic links in the documentation. | |
| autolink_file/2 | Files to which we automatically create links, regardless of the extension. | |
| indented_lines/3 | Extract a list of lines without leading blanks or characters from Prefix from Text. | |
| normalise_white_space/3 | Text is input after deleting leading and trailing white space and mapping all internal white space to a single space. | |
| section_comment_header/3 | Processes /** <section> comments. | |
| strip_leading_par/2 | Remove the leading paragraph for environments where a paragraph is not required. | |
| summary_from_lines/2 | Produce a summary for Lines. | |
| wiki_codes_to_dom/3 | Translate a plain text into a DOM term. | |
| wiki_lines_to_dom/3 | Translate a Wiki text into an HTML term suitable for html//1 from the html_write library. | |
| doc_wiki_face/4 | Hook that can be used to provide additional processing for additional inline wiki constructs. | |
| url_expansion_hook/3 | This hook is called after recognising <Alias:Rest>, where Term is of the form Alias(Rest). | |