/usr/lib/swipl/library/pldoc/doc_register.pl
AllApplicationManualNameSummaryHelp

  • library
    • pldoc
      • doc_process.pl -- Process source documentation
      • doc_register.pl
        • comment_hook/3
      • 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
      • doc_colour.pl -- Source colouring support
      • doc_access.pl
      • doc_pack.pl -- PlDoc for Prolog extension packs
      • doc_words.pl -- Reason about Prolog jargon
 prolog:comment_hook(+Comments, +TermPos, +Term) is det[multifile, pldoc(doc_register)]
Hook called by the compiler and cross-referencer. In addition to the comment, it passes the term itself to see what term is commented as well as the start-position of the term to distinguish between comments before the term and inside it.
Arguments:
Comments- List of comments read before the end of Term
TermPos- Start location of Term
Term- Actual term read