SMLDoc, detached from the SML# distribution
Standard ML HTML TeX OpenEdge ABL Makefile Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
SMLFormat
bin
doc
example/SMLBasis/src
mllex
mlyacc
package
smlnj-lib
src
.cvsignore
LICENSE
Makefile
Makefile.in
README.txt
SMLNJ_LICENSE
commonrule
configure
makesml
smldoc.cm

README.txt

SMLDoc : Document Generator for Standard ML

@author YAMATODANI Kiyoshi
@version $Id: README.txt,v 1.9 2007/04/12 05:48:06 kiyoshiy Exp $

This directory contains SMLDoc.
SMLDoc is a tool for generating API documentation in HTML format from
doc comments in source code written in Standard ML.

This software has been developed as a part of the SML# project.
It is distributed under the BSD-style SMLSharp license, which is
included in the file LICENSE in this directory.

For the details of SML# project, consult the web page at:
  http://www.pllab.riec.tohoku.ac.jp/smlsharp/

========================================
Build

 1) Configure and make

   $ ./configure
   $ make

 3) a script file "smldoc" and a heap image file are generated in the bin
   directory.
   If you want to move the heap image file to other place, you have to edit
   "smldoc" command to use the new location of the heap image file.


========================================
Unit test

 1) Specify SMLUNITDIR when invoke configuration.


 2) cd src/test.

   $ cd src/test

 3) start sml session.

   $ sml

 4) compile project

   - CM.make();

 5) run test runner

   - TestMain.test();
   ............................
   tests = 28, failures = 0, errors = 0
   Failures:
   Errors:
   val it = () : unit

========================================
NOTE

Some source files in the following directories are borrowed from SML/NJ distribution.

  src/main/HTML
  src/main/getopt/
  src/main/smlnjcm/

========================================
References

JavaDoc  (for Java)
http://java.sun.com/j2se/javadoc/

HDoc  (for Haskell)
http://www.fmi.uni-passau.de/~groessli/hdoc/

Haddoc
http://www.haskell.org/haddock/

OCamlDoc
http://caml.inria.fr/ocaml/htmlman/manual029.html
===============================================================================