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