Skip to content

Latest commit

 

History

History
154 lines (86 loc) · 2.99 KB

Readme.md

File metadata and controls

154 lines (86 loc) · 2.99 KB
Raw

SMLDoc : Document Generator for Standard ML

This is unofficial repository for SMLDoc distribution.

What is this

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

What is not this

  • This is not official repository.

Initially, contents of this repository is salvaged from the official SMLDoc distribution (included in SML# 0.90 compiler distribution).

Support platforms

  • SML#

    Not supported.

  • SML/NJ

    Tested 110.98

  • MLton

    Tested 20130715

Dependency

This project depends on:

SML/NJ

Build

To build the SMLDoc, run the smldoc target. This target requires SMLFormat which is referenced as $/smlformatlib.cm.

$ make -f Makefile.smlnj smldoc

Install

To install smldoc, run the install target.

$ make -f Makefile.smlnj install [PREFIX=/path/to/install]

This target install the command smldoc to $PREFIX/bin/smldoc.

Test

To run unit tests, run the test target. This target requires SMLUnit which is referenced as SMLUNIT_LIB.

$ make -f Makefile.smlnj test

Example

The example target generates documentation of SMLBasis library to doc/SMLBasis. And the smldoc-doc target generates documentations of SMLDoc itself to doc/smldoc which depends on the SMLBasis documentation.

$ make -f Makefile.smlnj example
$ make -f Makefile.smlnj smldoc-doc

MLton

Build

To build the SMLDoc, run the smldoc target of Makefile.mlton. This target requires SMLFormat which is referenced as SMLFORMAT_LIB.

$ export MLB_PATH_MAP=/path/to/mlb-path-map
$ make -f Makefile.mlton smldoc

Install

To install smldoc, run the install target.

$ make -f Makefile.mlton install [PREFIX=/path/to/install]

This target install the command smldoc to $PREFIX/bin/smldoc.

Test

To run unit tests, run the test target. This target requires SMLUnit which is referenced as SMLUNIT_LIB.

$ export MLB_PATH_MAP=path/to/mlb-path-map
$ make -f Makefile.mlton test

Example

The example target generates documentation of SMLBasis library to doc/SMLBasis. And the smldoc-doc target generates documentations of SMLDoc itself to doc/smldoc which depends on the SMLBasis documentation.

$ make -f Makefile.mlton example
$ make -f Makefile.mlton smldoc-doc

License

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/

Author

@author : YAMATODANI Kiyoshi

@copyright : 2010, Tohoku University.