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

 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.