Module Tools.Doc

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.

Imports

• import Data.Bits as Bits
• import Compiler.Main as C
• import Compiler.Classtools as CT
• import Compiler.common.CompilerOptions as CompilerOptions
• import Compiler.enums.Flags as Compilerflags
• import Data.List as DL
• import Compiler.common.Errors as Errors
• import Compiler.types.Global as G
• import Compiler.passes.Imp as I
• import Compiler.types.ImportDetails as ImportDetails
• import Compiler.types.NSNames as NSNames
• import Compiler.types.Packs as Packs
• import Compiler.types.Positions as Positions
• import frege.Prelude as Prelude
• import Prelude.PreludeArrays as PreludeArrays
• import Prelude.PreludeBase as PreludeBase
• import Prelude.PreludeDecimal as PreludeDecimal
• import Prelude.PreludeIO as PreludeIO
• import Prelude.PreludeList as PreludeList
• import Prelude.PreludeMonad as PreludeMonad
• import Prelude.PreludeText as PreludeText
• import Compiler.types.QNames as QNames
• import Java.util.Regex as Regexp
• import Control.monad.State as S
• import Compiler.types.SNames as SNames
• import Compiler.types.Symbols as Symbols
• import Data.TreeMap as TM
• import Java.Util as Util
• import Tools.doc.Utilities as Utilities
• import Compiler.enums.Visibility as Visibility
• import Java.util.Zip as Zip

Table of Content

• Definitions

  data Date = native java.util.Date

  data DocOpts

  options ∷ DocOpts

  main ∷ [String] → IO Bool

  scanOpts ∷ DocOpts → [String] → IO (Maybe (DocOpts, [String]))

  usage ∷ IO ()

  docThing ∷ Global → String → IO [Global]

  docArch ∷ Global → MutableIO File → IO [Global]

  docDir ∷ Global → MutableIO File → [String] → IO [Global]

  docDirEntry ∷ Global → MutableIO File → [String] → String → IO [Global]

  work ∷ String → StIO ()

  mkLinks ∷ NSName → Pack → StG ()

  continueImport ∷ StIO ()

  stime ∷ Long → String

  continueNamespaces ∷ FregePackage → StIO ()

• Functions and Values by Type

Definitions

data DocOpts

Constructors

DOpt {verbose ∷ Bool, docdir ∷ String, except ∷ [String], path ∷ [String]}

Member Functions

docdir ∷ DocOpts → String

path name of documentation root, must exist

except ∷ DocOpts → [String]

excluded modules

path ∷ DocOpts → [String]

class path

verbose ∷ DocOpts → Bool

print a line for each documentation file

options ∷ DocOpts

main ∷ [String] → IO Bool

scanOpts ∷ DocOpts → [String] → IO (Maybe (DocOpts, [String]))

usage ∷ IO ()

docThing ∷ Global → String → IO [Global]

docArch ∷ Global → MutableIO File → IO [Global]

docDir ∷ Global → MutableIO File → [String] → IO [Global]

docDirEntry ∷ Global → MutableIO File → [String] → String → IO [Global]

work ∷ String → StIO ()

make 1 documentation file

mkLinks ∷ NSName → Pack → StG ()

continueImport ∷ StIO ()

data Date = native java.util.Date

Member Functions

new ∷ Long → STMutable s Date
native new

toString ∷ Mutable s Date → ST s String
native toString

stime ∷ Long → String

continueNamespaces ∷ FregePackage → StIO ()

Functions and Values by Type

String → StIO ()

work

[String] → IO Bool

main

FregePackage → StIO ()

continueNamespaces

Global → MutableIO File → [String] → String → IO [Global]

docDirEntry

Global → MutableIO File → [String] → IO [Global]

docDir

Global → MutableIO File → IO [Global]

docArch

Global → String → IO [Global]

docThing

NSName → Pack → StG ()

mkLinks

Bool → String → [String] → [String] → DocOpts

DocOpts.DOpt

Long → String

stime

DocOpts → (String→String) → DocOpts

DocOpts.chg$docdir

DocOpts → ([String]→[String]) → DocOpts

DocOpts.chg$path, DocOpts.chg$except

DocOpts → (Bool→Bool) → DocOpts

DocOpts.chg$verbose

DocOpts → String → DocOpts

DocOpts.upd$docdir

DocOpts → [String] → IO (Maybe (DocOpts, [String]))

scanOpts

DocOpts → [String] → DocOpts

DocOpts.upd$path, DocOpts.upd$except

DocOpts → Bool → DocOpts

DocOpts.upd$verbose

DocOpts → String

DocOpts.docdir

DocOpts → [String]

DocOpts.path, DocOpts.except

DocOpts → Bool

DocOpts.verbose

StIO ()

continueImport

IO ()

usage

DocOpts

options

Mutable s Date → ST s String

Date.toString

Long → STMutable s Date

Date.new

𝖆 → Bool

DocOpts.has$verbose, DocOpts.has$except, DocOpts.has$docdir, DocOpts.has$path