Overview  Index  Help 
SMLDoc

DocComment


structure DocComment =
struct
  type id = string list
  type docComment = string * string * tag list
  datatype paramPattern =
           IDParamPat of string
         | TupleParamPat of paramPattern list
         | RecordParamPat of (string * paramPatternlist
  datatype tag =
           AuthorTag of string
         | ContributorTag of string
         | CopyrightTag of string
         | ExceptionTag of id * string
         | ParamTag of string * string
         | ParamsTag of paramPattern list
         | ReturnTag of string
         | SeeTag of string
         | VersionTag of string
end

documentation comment.

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

 
Type detail

id

type id = string list


docComment

type docComment = string * string * tag list

 
Datatype detail

paramPattern

datatype paramPattern =
         IDParamPat of string
       | TupleParamPat of paramPattern list
       | RecordParamPat of (string * paramPatternlist


tag

datatype tag =
         AuthorTag of string
       | ContributorTag of string
       | CopyrightTag of string
       | ExceptionTag of id * string
       | ParamTag of string * string
       | ParamsTag of paramPattern list
       | ReturnTag of string
       | SeeTag of string
       | VersionTag of string

 
DataConstructor detail

IDParamPat

constructor IDParamPat : string -> paramPattern


TupleParamPat

constructor TupleParamPat : paramPattern list -> paramPattern


RecordParamPat

constructor RecordParamPat : (string * paramPatternlist -> paramPattern


AuthorTag

constructor AuthorTag : string -> tag


ContributorTag

constructor ContributorTag : string -> tag


CopyrightTag

constructor CopyrightTag : string -> tag


ExceptionTag

constructor ExceptionTag : id * string -> tag


ParamTag

constructor ParamTag : string * string -> tag


ParamsTag

constructor ParamsTag : paramPattern list -> tag


ReturnTag

constructor ReturnTag : string -> tag


SeeTag

constructor SeeTag : string -> tag


VersionTag

constructor VersionTag : string -> tag

   


Overview  Index  Help 
SMLDoc: Documentation generator for SML