Overview  Index  Help 
SMLDoc

EXTERNALREF_LINKER

All Known Implementing Modules:

ExternalRefLinker


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

This modules reads/writes link files.

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.

Author:
YAMATODANI Kiyoshi
Version:
$Id: SigEXTERNALREF_LINKER.html,v 1.9 2007/02/17 07:01:57 kiyoshiy Exp $

       
Value detail

defaultModuleListFileName

val defaultModuleListFileName : string

the default name of link files


readLinkFile

fun readLinkFile parameter baseURL fileName baseENVSet
    : DocumentGenerationParameter.parameter ->
        string -> string -> ENVSet.ENVSet -> ENVSet.ENVSet

reads the link file.

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.

Author:
YAMATODANI Kiyoshi
Parameters:
parameter
common parameter
baseURL
the URL of the directory where HTML files for the elements listed in the link file are contained.
fileName
the name of link file
baseENVSet
the ENVSet which contains prelude elements and elements loaded from other linkfiles prior.
Returns:
extended environment set
Version:
1.0

writeLinkFile

fun writeLinkFile parameter fileName ENVSet
    : DocumentGenerationParameter.parameter -> string -> ENVSet.ENVSet -> unit

writes the ENVSet into a link file.

Author:
YAMATODANI Kiyoshi
Parameters:
parameter
common parameter
fileName
the name of file to be generated.
ENVSet
the ENVSet to be output
Returns:
unit
Version:
1.0

 


Overview  Index  Help 
SMLDoc: Documentation generator for SML