public class MetricsDoclet
extends com.sun.tools.doclets.standard.Standard
Takes a single parameter (-f file) to tell it where to output the resulting documentation file in HTML format.
Constructor and Description |
---|
MetricsDoclet() |
Modifier and Type | Method and Description |
---|---|
protected static String |
firstSentence(com.sun.javadoc.Doc doc)
Takes a Doc object and uses the firstSentenceTags() to recreate the first sentence
text.
|
protected static PrintStream |
getOutput(com.sun.javadoc.RootDoc root)
Gets the file output parameter from the RootDoc and then opens an
PrintStream to write to the file.
|
protected static boolean |
isMetricsClass(com.sun.javadoc.ClassDoc doc)
Checks to see if the class extends MetricBase using only the JavaDoc
metadata provided about the class.
|
static boolean |
start(com.sun.javadoc.RootDoc root)
Entry point called by the javadoc command line tool.
|
public static boolean start(com.sun.javadoc.RootDoc root)
root
- the root of the javadoc object hierarchyprotected static boolean isMetricsClass(com.sun.javadoc.ClassDoc doc)
doc
- the ClassDoc representing the class to be testedprotected static PrintStream getOutput(com.sun.javadoc.RootDoc root)
protected static String firstSentence(com.sun.javadoc.Doc doc)