| SMLDoc |
signature EXTERNALREF_LINKER =
sig
val defaultModuleListFileName : string
val readLinkFile
: DocumentGenerationParameter.parameter ->
string -> string -> ENVSet.ENVSet -> ENVSet.ENVSet
val writeLinkFile
: DocumentGenerationParameter.parameter -> string -> ENVSet.ENVSet -> unit
end
Link files list the names of ML program elements (modules and types) for which documents are generated in the specified location.
This module saves the structure of the ENVSet the elaborator generates into a link file and restores them from the linkfile.
Value detail |
---|
val defaultModuleListFileName : string
fun readLinkFile parameter baseURL fileName baseENVSet
: DocumentGenerationParameter.parameter ->
string -> string -> ENVSet.ENVSet -> ENVSet.ENVSet
The link file lists elements for which HTML documents are generated in the specified URL. This function reads the file and builds an ENVSet which contains external references to the elements listed in the file.
parameter
baseURL
fileName
baseENVSet
fun writeLinkFile parameter fileName ENVSet
: DocumentGenerationParameter.parameter -> string -> ENVSet.ENVSet -> unit
parameter
fileName
ENVSet
| SMLDoc: Documentation generator for SML |