- 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_for_file/2
- doc_resources//1
- doc_file_objects/5
- ensure_doc_objects/1
- module_info/3
- doc_hide_private/3
- private/2
- multifile/2
- file_header//2
- edit_button//2
- zoom_button//2
- source_button//2
- objects//2
- is_pi/1
- object_page//2
- object_page_footer//2
- object_synopsis//2
- unquote_filespec/2
- doc_write_html/3
- doc_page_dom/3
- print_html_head/1
- tags//1
- doc_tag_title/2
- object_tree//3
- pred_edit_button//2
- object_edit_button//2
- object_source_button//2
- is_op_type/2
- term//3
- predref//1
- predref//2
- object_ref//2
- object_href/2
- object_href/3
- object_name//2
- file//1
- file//2
- existing_linked_file/2
- include//3
- doc_for_wiki_file/2
- mode_anchor_name/2
- pred_anchor_name/3
- doc_is_public_object/1
- 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
- doc_file_objects(+FileSpec, -File, -Objects, -FileOptions, +Options) is det
- Extracts relevant information for FileSpec from the PlDoc
database. FileOptions contains:
file(Title:string, Comment:string)module(Module:atom)- public(Public:
list(predicate_indicator)
Objects contains
doc(PI:predicate_indicator, File:Line, Comment)
We distinguish three different states for FileSpec:
- File was cross-referenced with collection enabled. All information is in the xref database.
- File was loaded. If comments are not loaded, cross-reference the file, while storing the comments as the compiler would do.
- Neither of the above. In this case we cross-reference the file.
- Arguments:
-
FileSpec - File specification as used for load_files/2. File - Prolog canonical filename