[ library(document) | Reference Manual | Alphabetic Index ]
ecis_to_htmls(++LibDirs, ++HtmlTopDir, ++LinkBack, ++SystemName)
Generate an HTML documentation tree for the given library directories
- LibDirs
- A directory path name or a list of them
- HtmlTopDir
- A directory path name
- LinkBack
- HTML string (may be empty)
- SystemName
- A string (may be empty)
Description
This predicate finds all ECLiPSe interface information (.eci)
files in a list of directories and generates .html files in the
directory HtmlTopDir (which is created if it does not exist).
The generated files are:
- a toplevel index of all the processed directories
(only if LibDirs has more than one element)
- for each directory an index of all the processed .eci files
- the documentation generated from each .eci file
The LinkBack argument should contain a hyperlink in HTML format
which will appear at the top of the toplevel index. The
SystemName argument will appear in several places and should
be the name of the documented software system.
See Also
ecis_to_htmls / 0, eci_to_html / 3