• Places
    • Home
    • Graphs
    • Prefixes
  • Admin
    • Users
    • Settings
    • Plugins
    • Statistics
  • CPACK
    • Home
    • List packs
    • Submit pack
  • Repository
    • Load local file
    • Load from HTTP
    • Load from library
    • Remove triples
    • Clear repository
  • Query
    • YASGUI SPARQL Editor
    • Simple Form
    • SWISH Prolog shell
  • Help
    • Documentation
    • Tutorial
    • Roadmap
    • HTTP Services
  • Login

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

  • pldoc
    • pldoc
      • doc_process.pl -- Process source documentation
        • predicate_summary/2
        • is_structured_comment/2
        • doc_file_name/3
        • doc_file_has_comments/1
        • doc_comment/4
        • process_comments/3
        • parse_comment/3
        • comment_modes/2
        • doc_clean/1
      • doc_register.pl
      • doc_modes.pl -- Analyse PlDoc mode declarations
      • doc_wiki.pl -- PlDoc wiki parser
      • doc_util.pl -- PlDoc utilities
      • doc_htmlsrc.pl -- HTML source pretty-printer
      • doc_colour.pl -- Source colouring support
      • 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_words.pl -- Reason about Prolog jargon
      • man_index.pl -- Index the HTML manuals
      • doc_access.pl
      • doc_pack.pl -- PlDoc for Prolog extension packs
 process_comments(+Comments:list, +TermPos, +File) is det
Processes comments returned by read_term/3 using the comments option. It creates clauses of the form
  • '$mode'(Head, Det)
  • '$pldoc'(Id, Pos, Summary, Comment)
  • '$pldoc_link'(Id0, Id)

where Id is one of

module(Title)
Generated from /** <module> Title */
Name / Arity
Generated from Name(Arg, ...)
Name // Arity
Generated from Name(Arg, ...)//
Arguments:
Comments- is a list Pos-Comment returned by read_term/3
TermPos- is the start-location of the actual term
File- is the file that is being loaded.
ClioPatria (version V3.1.1-51-ga0b30a5)