Documentation for Jinni File: jdfp.pro
This module can be used to analyse a file documented by the JinniDoc documentation syntax. The file is analyzed to find the following information: - The files that it consults
- The libraries it consults
- Side-effects of loading in the file (i.e., actions that are performed upon loading)
- General information about the file
- Predicates defined in the file, along with information specified about them
- If the file is a module -- the module name and the predicates shown are only those exported
This information can be used to generate automatic documentation about the file.
Authored by:
Date: 24th of June, 2003
- analyze/8
Forms: - analyze(+FileName, ?FileConsults, ?LibConsults, ?SideEffects,?Details, ?General, ?ModuleName)
True if - FileConsults are the files consulted by FileName
- LibConsults are the libraries consulted by FileName
- SideEffects are the side-effects upon loading FileName
- Details are the information about the predicates defined in FileName (only those exported if FileName is a module
- General is general information about FileName
- ModuleName is the name of the module defined by FileName
consulting/3
intersection/3
jdfp/0
make_set/2
make_set/3
process_all/7
read_file/8
split_consult/3
split_names_arities/2
temp/1
union/3
JinniDoc © 2003-2005 Chico Toepfer