org.mule.devkit.doclet

Class Doclava

java.lang.Object

org.mule.devkit.doclet.Doclava

public class Doclava
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	apiVersion
static String	assetsOutputDir
static Map<Character,String>	escapeChars
static FederationTagger	federationTagger
static String	guideDir
static String	htmlExtension
static String	javadocDir
static com.google.clearsilver.jsilver.JSilver	jSilver
static HashSet<String>	knownTags
static ArrayList<String[]>	mHDFData
static ArrayList<String[]>	mMarkdown
static String	muleXmlDir
static com.sun.javadoc.RootDoc	root
static int	SHOW_HIDDEN
static int	SHOW_PACKAGE
static int	SHOW_PRIVATE
static int	SHOW_PROTECTED
static int	SHOW_PUBLIC
static int	showLevel
static SinceTagger	sinceTagger
static String	title

Constructor Summary

Constructors

Constructor and Description
Doclava()

Method Summary

Methods

Modifier and Type	Method and Description
static void	cantStripThis(ClassInfo cl, HashSet<ClassInfo> notStrippable)
static boolean	checkLevel(boolean pub, boolean prot, boolean pkgp, boolean priv, boolean hidden)
static boolean	checkLevel(int level)
static PackageInfo[]	chooseModulePackages()
static PackageInfo[]	choosePackages()
static String	escape(String s)
static com.sun.javadoc.LanguageVersion	languageVersion()
static String	linkTarget(String source, String target)
static void	main(String[] args)
static void	makeClassListHDF(com.google.clearsilver.jsilver.data.Data data, String base, ClassInfo[] classes)
static com.google.clearsilver.jsilver.data.Data	makeHDF()
static void	makeModuleListHDF(com.google.clearsilver.jsilver.data.Data data, String base, ClassInfo[] classes)
static com.google.clearsilver.jsilver.data.Data	makePackageHDF()
static int	optionLength(String option)
static boolean	parseComments() Returns true if we should parse javadoc comments, reporting errors in the process.
static void	setPageTitle(com.google.clearsilver.jsilver.data.Data data, String title)
static boolean	start(com.sun.javadoc.RootDoc r)
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter r)
static void	writeAssets()
static void	writeClass(ClassInfo cl, com.google.clearsilver.jsilver.data.Data data)
static void	writeClasses()
static void	writeClassLists()
static void	writeHierarchy()
static void	writeKeepList(String filename) Writes the list of classes that must be present in order to provide the non-hidden APIs known to javadoc.
static void	writeLists()
static void	writeMarkdowns()
static void	writeModule(ClassInfo cl, com.google.clearsilver.jsilver.data.Data data)
static void	writeModules(String filename)
static void	writePackage(PackageInfo pkg)
static void	writePackages(String filename)
static void	writeSource(ClassInfo cl, com.google.clearsilver.jsilver.data.Data data)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHOW_PUBLIC

public static final int SHOW_PUBLIC

See Also:

Constant Field Values

SHOW_PROTECTED

public static final int SHOW_PROTECTED

See Also:

Constant Field Values

SHOW_PACKAGE

public static final int SHOW_PACKAGE

See Also:

Constant Field Values

SHOW_PRIVATE

public static final int SHOW_PRIVATE

See Also:

Constant Field Values

SHOW_HIDDEN

public static final int SHOW_HIDDEN

See Also:

Constant Field Values

showLevel

public static int showLevel

javadocDir

public static final String javadocDir

See Also:

Constant Field Values

muleXmlDir

public static final String muleXmlDir

See Also:

Constant Field Values

guideDir

public static final String guideDir

See Also:

Constant Field Values

assetsOutputDir

public static String assetsOutputDir

htmlExtension

public static String htmlExtension

root

public static com.sun.javadoc.RootDoc root

mHDFData

public static ArrayList<String[]> mHDFData

mMarkdown

public static ArrayList<String[]> mMarkdown

escapeChars

public static Map<Character,String> escapeChars

title

public static String title

sinceTagger

public static SinceTagger sinceTagger

knownTags

public static HashSet<String> knownTags

federationTagger

public static FederationTagger federationTagger

apiVersion

public static String apiVersion

jSilver

public static com.google.clearsilver.jsilver.JSilver jSilver

Constructor Detail

Doclava

public Doclava()

Method Detail

checkLevel

public static boolean checkLevel(int level)

parseComments

public static boolean parseComments()

Returns true if we should parse javadoc comments, reporting errors in the process.

checkLevel

public static boolean checkLevel(boolean pub,
                 boolean prot,
                 boolean pkgp,
                 boolean priv,
                 boolean hidden)

main

public static void main(String[] args)

start

public static boolean start(com.sun.javadoc.RootDoc r)

escape

public static String escape(String s)

setPageTitle

public static void setPageTitle(com.google.clearsilver.jsilver.data.Data data,
                String title)

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

optionLength

public static int optionLength(String option)

validOptions

public static boolean validOptions(String[][] options,
                   com.sun.javadoc.DocErrorReporter r)

makeHDF

public static com.google.clearsilver.jsilver.data.Data makeHDF()

makePackageHDF

public static com.google.clearsilver.jsilver.data.Data makePackageHDF()

writeAssets

public static void writeAssets()

writeLists

public static void writeLists()

cantStripThis

public static void cantStripThis(ClassInfo cl,
                 HashSet<ClassInfo> notStrippable)

writeKeepList

public static void writeKeepList(String filename)

Writes the list of classes that must be present in order to provide the non-hidden APIs known to javadoc.

Parameters:

filename - the path to the file to write the list to

choosePackages

public static PackageInfo[] choosePackages()

chooseModulePackages

public static PackageInfo[] chooseModulePackages()

writePackages

public static void writePackages(String filename)

writeMarkdowns

public static void writeMarkdowns()

writeModules

public static void writeModules(String filename)

writeModule

public static void writeModule(ClassInfo cl,
               com.google.clearsilver.jsilver.data.Data data)

writePackage

public static void writePackage(PackageInfo pkg)

writeClassLists

public static void writeClassLists()

writeHierarchy

public static void writeHierarchy()

writeClasses

public static void writeClasses()

writeClass

public static void writeClass(ClassInfo cl,
              com.google.clearsilver.jsilver.data.Data data)

writeSource

public static void writeSource(ClassInfo cl,
               com.google.clearsilver.jsilver.data.Data data)

makeClassListHDF

public static void makeClassListHDF(com.google.clearsilver.jsilver.data.Data data,
                    String base,
                    ClassInfo[] classes)

makeModuleListHDF

public static void makeModuleListHDF(com.google.clearsilver.jsilver.data.Data data,
                     String base,
                     ClassInfo[] classes)

linkTarget

public static String linkTarget(String source,
                String target)