/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
      • doc_colour.pl
      • doc_man.pl -- Process SWI-Prolog HTML manuals
      • doc_access.pl
      • doc_pack.pl
 doc_comment(?Objects, -Pos, -Summary:string, -Comment:string) is nondet
True if Comment is the comment describing object. Comment is returned as a string object containing the original from the source-code. Object is one of
  • Name/Arity Predicate indicator
  • Name//Arity DCG rule indicator. Same as Name/Arity+2
  • module(ModuleTitle) Comment appearing in a module.
  • Other objects Created by the hook doc_compile_comment/5, e.g., xpce(Class, Kind, Name) for members of xpce classes.

If Object is unbound and multiple objects share the same description, Object is unified with a list of terms described above.

Arguments:
Summary- First sentence. Normalised spacing.
Comment- Comment string from the source-code (untranslated)