org.kepler.kar

Class KarDoclet

java.lang.Object

org.kepler.kar.KarDoclet

public class KarDoclet
extends java.lang.Object

A doclet that creates documentation for KAR files.

Author:

Daniel Crawl

Constructor Summary

Constructors

Constructor and Description
KarDoclet()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,KeplerDocumentationAttribute>	getAllDocs() Retrieve all the documentation.
static KeplerDocumentationAttribute	getDoc(java.lang.String name) Retrieve the documentation for a particular class after it has been created.
static boolean	isClassDeprecated(java.lang.String className) Returns true if the given class name is deprecated.
static void	setGenerateForDeprecated(boolean generate) Set if documentation will be generated for deprecated classes.
static void	setWorkspace(Workspace workspace)
static boolean	start(com.sun.javadoc.RootDoc root) The entry point called from javadoc.

Methods inherited from class java.lang.Object

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

Constructor Detail

KarDoclet

public KarDoclet()

Method Detail

start

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

The entry point called from javadoc.

getDoc

public static KeplerDocumentationAttribute getDoc(java.lang.String name)

Retrieve the documentation for a particular class after it has been created.

getAllDocs

public static java.util.Map<java.lang.String,KeplerDocumentationAttribute> getAllDocs()

Retrieve all the documentation.

isClassDeprecated

public static boolean isClassDeprecated(java.lang.String className)

Returns true if the given class name is deprecated. NOTE: this method does not look at the tags of the class; the doclet must be run on the source file first.

setGenerateForDeprecated

public static void setGenerateForDeprecated(boolean generate)

Set if documentation will be generated for deprecated classes.

setWorkspace

public static void setWorkspace(Workspace workspace)