Overview  Index  Help 
SMLDoc

SMLDoc 0.10

 
Inner Signature summary

signature AST
           abstract syntax tree.

signature ASTUTIL
           Utility functions manipulating abstract syntax tree.

signature CMFILE_PARSER
           parser of SML/NJ CM description file.

signature CM_SEMANTIC
           semantic actions to go with the grammar for CM description files

signature DEPENDENCY_ANALYZER
           This module analyses dependency relation between the compilation units the parser generated.

signature DEPENDENCY_GRAPH
           the signature of the module which provides operations on the dependency graph.

signature DOCUMENT_GENERATOR
           The signature of modules which generates documents describing the given program.

signature EASY_HTML_PARSER
           This module provides functions parsing HTML documents.

signature ELABORATOR
           elaborates abstract syntax tree generated by the parser.

signature EXTERNALREF_LINKER
           This modules reads/writes link files.

signature FILE_ID
           Abstract file IDs.

signature GETOPT
           A SML port of GNU's getopt library.

signature HTML
           This file defines the abstract syntax of HTML documents.

signature PARSER
           Parser of ML program which may contain documentation comments.

signature PATH_UTILITY
           Utility functions for path manipulation.

signature SMLDOC
           The top level module of the SMLDoc.

signature SOURCE_PATH
           Operations over abstract names for CM source files.

signature SUMMARIZER
           signature of module which analyse the elaborated AST and produce the summarized information useful for the document generator.

 
Inner Structure summary

structure AnnotatedAst
           abstract syntax tree annotated with doc comment.

structure Ast
           abstract syntax tree.

structure AstUtil
           Utility functions manipulating abstract syntax tree.

structure Binds
           binding information.

structure CMFileParser
          

structure CMSemantic
          

structure DependencyAnalyzer
           This module analyses dependency relation between the compilation units the parser generated.

structure DependencyGraph
           the signature of the module which provides operations on the dependency graph.

structure DocComment
           documentation comment.

structure DocumentGenerationParameter
           parameter for ducument generation.

structure EasyHTMLParser
          

structure ElaboratedAst
           data structures generated by elaboration.

structure Elaborator
          

structure ENVSet
           environment with module hierarchy.

structure ExternalRefLinker
          

structure FileID
          

structure GetOpt
          

structure HTML
           This file defines the abstract syntax of HTML documents.

structure HTMLDocumentGenerator
           This module generates HTML documents describing the given program.

structure Linkage
           information of links between entities.

structure LinkFile
           datatype of linke file which describes linkage information.

structure Main
           entry point.

structure MakeHTML
           This is a collection of constructors for building some of the common kinds of HTML elements.

structure Parser
          

structure ParserUtil
           Utilities for parser.

structure PathUtility
           Utility functions for file path manipulation.

structure PrHTML
           Pretty-print an HTML tree.

structure SMLDoc
          

structure SourcePath
          

structure Summarizer
          

structure Utility
           This module provides functions independent of the specific applications.

   
Inner Functor summary

functor TokenTable
           hash table for token recognition.

         

         


Overview  Index  Help 
SMLDoc: Documentation generator for SML