Overview  Index  Help 
SMLDoc

Main


structure Main =
struct
  structure G = GetOpt
  structure U = Utility
  structure PU = PathUtility
  structure DGP = DocumentGenerationParameter
  datatype parameterOption =
           ArgFile of string
         | Author
         | Contributor
         | Copyright
         | Bottom of string
         | CharSet of string
         | Directory of string
         | DocTitle of string
         | Footer of string
         | Header of string
         | Help
         | HelpFile of string
         | HideBySig
         | Link of string
         | LinkOffline of string
         | LinkSource
         | ListSubModule
         | NoHelp
         | NoIndex
         | NoNavBar
         | NoWarning
         | Overview of string
         | Recursive
         | ShowSummary
         | SplitIndex
         | StdIn
         | Use
         | Verbose
         | Version
         | WindowTitle of string
  exception InvalidParameter of string
  val usageHeader
  val optionDescs
  val parseCommandLine
  val parseArgFile
  val expandFileName
  val main
end

entry point.

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

   
Datatype detail

parameterOption

datatype parameterOption =
         ArgFile of string
       | Author
       | Contributor
       | Copyright
       | Bottom of string
       | CharSet of string
       | Directory of string
       | DocTitle of string
       | Footer of string
       | Header of string
       | Help
       | HelpFile of string
       | HideBySig
       | Link of string
       | LinkOffline of string
       | LinkSource
       | ListSubModule
       | NoHelp
       | NoIndex
       | NoNavBar
       | NoWarning
       | Overview of string
       | Recursive
       | ShowSummary
       | SplitIndex
       | StdIn
       | Use
       | Verbose
       | Version
       | WindowTitle of string

 
DataConstructor detail

ArgFile

constructor ArgFile : string -> parameterOption


Author

constructor Author : parameterOption


Contributor

constructor Contributor : parameterOption


Copyright

constructor Copyright : parameterOption


Bottom

constructor Bottom : string -> parameterOption


CharSet

constructor CharSet : string -> parameterOption


Directory

constructor Directory : string -> parameterOption


DocTitle

constructor DocTitle : string -> parameterOption


Footer

constructor Footer : string -> parameterOption


Header

constructor Header : string -> parameterOption


Help

constructor Help : parameterOption


HelpFile

constructor HelpFile : string -> parameterOption


HideBySig

constructor HideBySig : parameterOption


Link

constructor Link : string -> parameterOption


LinkOffline

constructor LinkOffline : string -> parameterOption


LinkSource

constructor LinkSource : parameterOption


ListSubModule

constructor ListSubModule : parameterOption


NoHelp

constructor NoHelp : parameterOption


NoIndex

constructor NoIndex : parameterOption


NoNavBar

constructor NoNavBar : parameterOption


NoWarning

constructor NoWarning : parameterOption


Overview

constructor Overview : string -> parameterOption


Recursive

constructor Recursive : parameterOption


ShowSummary

constructor ShowSummary : parameterOption


SplitIndex

constructor SplitIndex : parameterOption


StdIn

constructor StdIn : parameterOption


Use

constructor Use : parameterOption


Verbose

constructor Verbose : parameterOption


Version

constructor Version : parameterOption


WindowTitle

constructor WindowTitle : string -> parameterOption

 
Value detail

usageHeader

val usageHeader


optionDescs

val optionDescs


parseCommandLine

val parseCommandLine


parseArgFile

val parseArgFile


expandFileName

val expandFileName

filePath must be absolute path.


main

val main

 
Exception detail

InvalidParameter

exception InvalidParameter of string


Overview  Index  Help 
SMLDoc: Documentation generator for SML