System.Build.Java.Javadoc
Description
A module for documenting Java source files using javadoc.
- data Javadoc
- data SourceRelease
- overview :: Javadoc -> Maybe FilePath
- public :: Javadoc -> Bool
- protected :: Javadoc -> Bool
- package :: Javadoc -> Bool
- private :: Javadoc -> Bool
- help :: Javadoc -> Bool
- doclet :: Javadoc -> Maybe String
- docletpath :: Javadoc -> Maybe FilePath
- sourcepath :: Javadoc -> [FilePath]
- classpath :: Javadoc -> [FilePath]
- exclude :: Javadoc -> [String]
- subpackages :: Javadoc -> [String]
- breakiterator :: Javadoc -> Bool
- bootclasspath :: Javadoc -> [FilePath]
- source :: Javadoc -> Maybe SourceRelease
- extdirs :: Javadoc -> [FilePath]
- verbose :: Javadoc -> Bool
- locale :: Javadoc -> Maybe String
- encoding :: Javadoc -> Maybe String
- quiet :: Javadoc -> Bool
- flags :: Javadoc -> [String]
- directory :: Javadoc -> Maybe FilePath
- use :: Javadoc -> Bool
- version :: Javadoc -> Bool
- author :: Javadoc -> Bool
- docfilessubdirs :: Javadoc -> Bool
- splitindex :: Javadoc -> Bool
- windowtitle :: Javadoc -> Maybe String
- doctitle :: Javadoc -> Maybe String
- header :: Javadoc -> Maybe String
- footer :: Javadoc -> Maybe String
- top :: Javadoc -> Maybe String
- bottom :: Javadoc -> Maybe String
- link :: Javadoc -> [String]
- linkoffline :: Javadoc -> [(String, String)]
- excludedocfilessubdir :: Javadoc -> [String]
- group :: Javadoc -> [(String, [String])]
- nocomment :: Javadoc -> Bool
- nodeprecated :: Javadoc -> Bool
- noqualifier :: Javadoc -> [String]
- nosince :: Javadoc -> Bool
- notimestamp :: Javadoc -> Bool
- nodeprecatedlist :: Javadoc -> Bool
- notree :: Javadoc -> Bool
- noindex :: Javadoc -> Bool
- nohelp :: Javadoc -> Bool
- nonavbar :: Javadoc -> Bool
- serialwarn :: Javadoc -> Bool
- tag :: Javadoc -> [(String, String, String)]
- taglet :: Javadoc -> Bool
- tagletpath :: Javadoc -> Bool
- charset :: Javadoc -> Maybe String
- helpfile :: Javadoc -> Maybe FilePath
- linksource :: Javadoc -> Bool
- sourcetab :: Javadoc -> Maybe Int
- keywords :: Javadoc -> Bool
- stylesheetfile :: Javadoc -> Maybe FilePath
- docencoding :: Javadoc -> Maybe String
- javadoc :: Javadoc
- javadoc' :: Maybe FilePath -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe String -> Maybe FilePath -> [FilePath] -> [FilePath] -> [String] -> [String] -> Bool -> [FilePath] -> Maybe SourceRelease -> [FilePath] -> Bool -> Maybe String -> Maybe String -> Bool -> [String] -> Maybe FilePath -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> [String] -> [(String, String)] -> [String] -> [(String, [String])] -> Bool -> Bool -> [String] -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> [(String, String, String)] -> Bool -> Bool -> Maybe String -> Maybe FilePath -> Bool -> Maybe Int -> Bool -> Maybe FilePath -> Maybe String -> Javadoc
Documentation
Javadoc is the compiler for Java API documentation.
Data types references by Javadoc
Javadoc members
docletpath :: Javadoc -> Maybe FilePathSource
-docletpath
sourcepath :: Javadoc -> [FilePath]Source
-sourcepath
subpackages :: Javadoc -> [String]Source
-subpackages
breakiterator :: Javadoc -> BoolSource
-breakiterator
bootclasspath :: Javadoc -> [FilePath]Source
-bootclasspath
source :: Javadoc -> Maybe SourceReleaseSource
-source
docfilessubdirs :: Javadoc -> BoolSource
-docfilessubdirs
splitindex :: Javadoc -> BoolSource
-splitindex
windowtitle :: Javadoc -> Maybe StringSource
-windowtitle
linkoffline :: Javadoc -> [(String, String)]Source
-linkoffline
excludedocfilessubdir :: Javadoc -> [String]Source
-excludedocfilessubdir
nodeprecated :: Javadoc -> BoolSource
-nodeprecated
noqualifier :: Javadoc -> [String]Source
-noqualifier
notimestamp :: Javadoc -> BoolSource
-notimestamp
nodeprecatedlist :: Javadoc -> BoolSource
-nodeprecatedlist
serialwarn :: Javadoc -> BoolSource
-serialwarn
tagletpath :: Javadoc -> BoolSource
-tagletpath
linksource :: Javadoc -> BoolSource
-linksource
stylesheetfile :: Javadoc -> Maybe FilePathSource
-stylesheetfile
docencoding :: Javadoc -> Maybe StringSource
-docencoding
Javadoc values
javadoc' :: Maybe FilePath -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe String -> Maybe FilePath -> [FilePath] -> [FilePath] -> [String] -> [String] -> Bool -> [FilePath] -> Maybe SourceRelease -> [FilePath] -> Bool -> Maybe String -> Maybe String -> Bool -> [String] -> Maybe FilePath -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> [String] -> [(String, String)] -> [String] -> [(String, [String])] -> Bool -> Bool -> [String] -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> [(String, String, String)] -> Bool -> Bool -> Maybe String -> Maybe FilePath -> Bool -> Maybe Int -> Bool -> Maybe FilePath -> Maybe String -> JavadocSource
Construct a Javadoc.