- library
- pldoc
- doc_process.pl -- Process source documentation
- doc_register.pl
- doc_modes.pl -- Analyse PlDoc mode declarations
- doc_wiki.pl -- PlDoc wiki parser
- 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_util.pl -- PlDoc utilities
- doc_access.pl
- doc_pack.pl -- PlDoc for Prolog extension packs
- pldoc
- 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.