|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.umlgraph.doclet.UmlGraphDoc
public class UmlGraphDoc
Chaining doclet that runs the standart Javadoc doclet first, and on success, runs the generation of dot files by UMLGraph
Field Summary | |
---|---|
private static String |
EXPANDABLE_UML
|
private static String |
UML_DIV_TAG
|
Constructor Summary | |
---|---|
UmlGraphDoc()
|
Method Summary | |
---|---|
private static void |
alterHtmlDocs(Options opt,
String outputFolder,
String packageName,
String className,
String htmlFileName,
Pattern insertPointPattern,
RootDoc root)
Takes an HTML file, looks for the first instance of the specified insertion point, and inserts the diagram image reference and a client side map in that point. |
private static String |
findOutputPath(String[][] options)
Returns the output path specified on the javadoc options |
private static void |
generateContextDiagrams(RootDoc root,
Options opt,
String outputFolder)
Generates the context diagram for a single class |
private static void |
generatePackageDiagrams(RootDoc root,
Options opt,
String outputFolder)
Generates the package diagrams for all of the packages that contain classes among those returned by RootDoc.class() |
private static void |
insertClientSideMap(File mapFile,
BufferedWriter writer)
Reads the map file and outputs in to the specified writer |
static LanguageVersion |
languageVersion()
Standand doclet entry |
static int |
optionLength(String option)
Option check, forwards options to the standard doclet, if that one refuses them, they are sent to UmlGraph |
private static void |
runGraphviz(String dotExecutable,
String outputFolder,
String packageName,
String name,
RootDoc root)
Runs Graphviz dot building both a diagram (in png format) and a client side map for it. |
static boolean |
start(RootDoc root)
Standard doclet entry point |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final String UML_DIV_TAG
private static final String EXPANDABLE_UML
Constructor Detail |
---|
public UmlGraphDoc()
Method Detail |
---|
public static int optionLength(String option)
public static boolean start(RootDoc root)
root
-
public static LanguageVersion languageVersion()
private static void generatePackageDiagrams(RootDoc root, Options opt, String outputFolder) throws IOException
IOException
private static void generateContextDiagrams(RootDoc root, Options opt, String outputFolder) throws IOException
IOException
private static void runGraphviz(String dotExecutable, String outputFolder, String packageName, String name, RootDoc root)
private static void alterHtmlDocs(Options opt, String outputFolder, String packageName, String className, String htmlFileName, Pattern insertPointPattern, RootDoc root) throws IOException
IOException
private static void insertClientSideMap(File mapFile, BufferedWriter writer) throws IOException
IOException
private static String findOutputPath(String[][] options)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |