| Did you know ... | Search Documentation: |
 | Predicate doc_file_objects/5 |
- HOME
- DOWNLOAD
- DOCUMENTATION
- TUTORIALS
- Beginner▶
- Advanced▶
- Web applications▶
- Semantic web▶
- Graphics▶
- Machine learning▶
- External collections▶
- For packagers▶
- COMMUNITY
- COMMERCIAL
- WIKI
Availability:
:- use_module(pldoc(doc_html)).- 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.