Package frege.tools.Doc

Compiled: Wed Dec 05 00:08:39 PST 2012 from source file: ./frege/tools/Doc.fr

Package Documentation

This program reads java class files that are the result of compiling a frege package and writes a documentation of that package. All public classes, instances, data types, type aliases and functions are listed along with programmer supplied documentation from /doc/ comments.

Usage:

java frege.tools.Doc [-d docpath] your.frege.Package ...

This creates or updates the documentation files for the packages named on the command line. A documentation file for package a.b.C will be written in file docpath/a/b/C.html, where docpath must be an existing directory.

If the -d flag is not given, the current directory is assumed for docpath.

The generated HTML will contain links to the documentation files of imported packages, which are assumed to exist in the same docpath.

Table of Content

Imports

Data Types

data Date s = native java.util.Date

Member Functions

new :: Long -> Mutable Date s
native new
toString :: Date s -> ST s String
native toString

Functions and Values

classes :: [String] -> StG ()
continueImport :: StG ()
continueNamespaces :: FregePackage -> StG ()
main :: [String] -> IO ()
mkLinks :: NSName -> Pack -> StG ()
stime :: Long -> String
work :: String -> StG ()

make 1 documentation file

Functions and Values by Type

String -> StG ()

work

[String] -> IO ()

main

[String] -> StG ()

classes

FregePackage -> StG ()

continueNamespaces

NSName -> Pack -> StG ()

mkLinks

Long -> String

stime

StG ()

continueImport

Date s -> ST s String

Date.toString

Long -> Mutable Date s

Date.new

Valid HTML 4.01 Strict