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 | ||
|---|---|---|
| host_access_options/2 | Filter the authorization options from AllOptions, leaving the remaining options in NoAuthOptions. | |
| doc_colour.pl -- Source colouring support | ||
| colour_fragments/2 | Create a list of colour fragments from In. | |
| 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 | ||
| dir_index/4 | Create an index for all Prolog files appearing in Dir or in any directory contained in Dir. | |
| doc_file_href/2 | Create a /doc HREF from Path. | |
| doc_for_dir/2 | Write summary index for all files in Dir to Out. | |
| doc_links/4 | Provide overview links and search facilities. | |
| file_index_header/4 | Create an entry in a summary-table for File. | |
| object_summaries/5 | Create entries in a summary table for Objects. | |
| places_menu/3 | Create a select menu with entries for all loaded directories. | |
| source_directory/1 | True if Dir is a directory from which we have loaded Prolog sources. | |
| 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 | ||
| 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 | ||
| 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 | ||