Overview  Index  Help 
SMLDoc

PARSER

All Known Implementing Modules:

Parser


signature PARSER =
sig
  type context
  val emptyContext : context
  val addInfix : string * context -> context
  val parseFile
      : DocumentGenerationParameter.parameter ->
          context -> string -> AnnotatedAst.compileUnit
end

Parser of ML program which may contain documentation comments.

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

 
Type detail

context

type context

type of context of parsing

     
Value detail

emptyContext

val emptyContext : context

empty context


addInfix

fun addInfix (name, context) : string * context -> context

add a name of the infix operator into the context.

Author:
YAMATODANI Kiyoshi
Parameters:
name
the name of the infix operator
context
a context
Returns:
a new context which includes the name as infix operator.
Version:
1.0

parseFile

fun parseFile parameter context fileName
    : DocumentGenerationParameter.parameter ->
        context -> string -> AnnotatedAst.compileUnit

parses a file which contains ML program annotated with documentation comments.

Author:
YAMATODANI Kiyoshi
Parameters:
parameter
the global parameter
context
the context
fileName
the name of the file containing ML program.
Returns:
a compilation unit which contains abstract syntax tree of the ML program
Version:
1.0

 


Overview  Index  Help 
SMLDoc: Documentation generator for SML