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 | ||
| 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_pack/1 | Generate stand-alone documentation for the package Pack. | |
| doc_process.pl -- Process source documentation | ||
| doc_register.pl | ||
| doc_search.pl -- Search form and reply | ||
| doc_util.pl -- PlDoc utilities | ||
| doc_wiki.pl -- PlDoc wiki parser | ||