/usr/lib/swipl/library/ext/pldoc/pldoc/doc_htmlsrc.pl
All Application Manual Name SummaryHelp

  • pldoc
    • pldoc
      • doc_process.pl -- Process source documentation
      • doc_register.pl
      • doc_modes.pl -- Analyse PlDoc mode declarations
      • doc_wiki.pl -- PlDoc wiki parser
      • doc_util.pl -- PlDoc utilities
      • man_index.pl -- Index the HTML manuals
      • doc_html.pl -- PlDoc HTML backend
      • doc_man.pl -- Process SWI-Prolog HTML manuals
      • doc_search.pl -- Search form and reply
      • doc_index.pl -- Create indexes
      • doc_htmlsrc.pl -- HTML source pretty-printer
        • source_to_html/3
      • doc_colour.pl -- Source colouring support
      • doc_access.pl
      • doc_pack.pl -- PlDoc for Prolog extension packs
      • doc_words.pl -- Reason about Prolog jargon
 source_to_html(+In:filename, +Out, :Options) is det
Colourise Prolog source as HTML. The idea is to first create a sequence of fragments and then to apply these to the code. Options are:
format_comments(+Boolean)
If true (default), use PlDoc formatting for structured comments.

Other options are passed to the following predicates:

  • print_html_head/2
  • print_html_footer/2.
  • html_fragments/6
Arguments:
In- A filename. Can also be an abstract name, which is subject to library(prolog_source) abstract file handling. See prolog_open_source/2. Note that this cannot be a stream as we need to read the file three times: (1) xref, (2) assign colours and (3) generate HTML.
Out- Term stream(Stream) or filename specification