Overview  Index  Help 
SMLDoc

DocumentGenerationParameter


structure DocumentGenerationParameter =
struct
  datatype parameter =
           Parameter of
           {
             author : bool,
             contributor : bool,
             copyright : bool,
             bottom : string option,
             charSet : string option,
             directory : string,
             docTitle : string option,
             footer : string option,
             header : string option,
             helpfile : string option,
             help : bool,
             hideBySig : bool,
             index : bool,
             links : {URL : string, linkFile : stringlist,
             linkSource : bool,
             listSubModule : bool,
             overview : string option,
             printWarning : bool,
             recursive : bool,
             navbar : bool,
             showSummary : bool,
             splitIndex : bool,
             uses : bool,
             version : bool,
             verbose : bool,
             windowTitle : string option
           }
  val warn
  val error
  val onProgress
end

parameter for ducument generation.

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

   
Datatype detail

parameter

datatype parameter =
         Parameter of
         {
           author : bool,
           contributor : bool,
           copyright : bool,
           bottom : string option,
           charSet : string option,
           directory : string,
           docTitle : string option,
           footer : string option,
           header : string option,
           helpfile : string option,
           help : bool,
           hideBySig : bool,
           index : bool,
           links : {URL : string, linkFile : stringlist,
           linkSource : bool,
           listSubModule : bool,
           overview : string option,
           printWarning : bool,
           recursive : bool,
           navbar : bool,
           showSummary : bool,
           splitIndex : bool,
           uses : bool,
           version : bool,
           verbose : bool,
           windowTitle : string option
         }

 
DataConstructor detail

Parameter

constructor Parameter
            : {
                author : bool,
                contributor : bool,
                copyright : bool,
                bottom : string option,
                charSet : string option,
                directory : string,
                docTitle : string option,
                footer : string option,
                header : string option,
                helpfile : string option,
                help : bool,
                hideBySig : bool,
                index : bool,
                links : {URL : string, linkFile : stringlist,
                linkSource : bool,
                listSubModule : bool,
                overview : string option,
                printWarning : bool,
                recursive : bool,
                navbar : bool,
                showSummary : bool,
                splitIndex : bool,
                uses : bool,
                version : bool,
                verbose : bool,
                windowTitle : string option
              } ->
                parameter

 
Value detail

warn

val warn


error

val error


onProgress

val onProgress

 


Overview  Index  Help 
SMLDoc: Documentation generator for SML