file(s)
. Options
include
- format(+Format)
- Currently only supports
html
. - doc_root(+Dir)
- Save output to the given directory. Default is to save the documentation
for a file in the same directory as the file and for a directory in a
subdirectory
doc
. - title(+Title)
- Title is an atom that provides the HTML title of the main (index) page. Only meaningful when generating documentation for a directory.
- man_server(+RootURL)
- Root of a manual server used for references to built-in predicates.
Default is
http://www.swi-prolog.org/pldoc/
- index_file(+Base)
- Filename for directory indices. Default is
index
. - if(Condition)
- What to do with files in a directory.
loaded
(default) only documents files loaded into the Prolog image.true
documents all files. - recursive(+Bool)
- If
true
, recurse into subdirectories. - css(+Mode)
- If
copy
, copy the CSS file to created directories. Usinginline
, include the CSS file into the created files. Currently, only the defaultcopy
is supported. - include_reexported(+Boolean)
- When
true
(defaultfalse
), include predicates that are re-exported from this module into the documentation of the module.