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

  • pldoc
    • pldoc
      • doc_process.pl -- Process source documentation
        • is_structured_comment/2
        • doc_file_name/3
        • doc_file_has_comments/1
        • doc_comment/4
        • doc_signature/2
        • process_comments/3
        • process_comments/5
        • parse_comment/3
        • parse_comment/5
        • comment_modes/2
        • doc_clean/1
        • predicate_summary/2
        • doc_compile_comment/6
      • 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_index.pl -- Create indexes
      • doc_search.pl -- Search form and reply
      • doc_words.pl -- Reason about Prolog jargon
      • doc_htmlsrc.pl -- HTML source pretty-printer
      • doc_colour.pl -- Source colouring support
      • doc_man.pl -- Process SWI-Prolog HTML manuals
      • doc_access.pl
      • doc_pack.pl
 prolog:doc_compile_comment(+Comment:string, +Lines, +FilePos, ?Term, +VarNames, -Compiled:list) is semidet[multifile, library(pldoc/doc_process)]
Hook to compile structured comments that do not document a predicate or section, such as the members of an xpce class. The hook is tried before the default processing. Lines are the indented lines of Comment and Term is the term that follows the comment. Term is unbound if Comment is not the last comment before the term. VarNames is a list Name=Var for the variables of Term. If the hook succeeds, Compiled is a list of terms as described with parse_comment/3, normally holding object(Object, Summary, Comment) and optionally signature(Object, Signature).