org.umlgraph.doclet

Class UmlGraph

java.lang.Object

org.umlgraph.doclet.UmlGraph

public class UmlGraph
extends java.lang.Object

Doclet API implementation

Constructor Summary

Constructors

Constructor and Description
UmlGraph()

Method Summary

Methods

Modifier and Type	Method and Description
static void	buildGraph(RootDoc root, OptionProvider op, Doc contextDoc) Builds and outputs a single graph according to the view overrides
static Options	buildOptions(RootDoc root) Creates the base Options object.
static View[]	buildViews(Options opt, RootDoc srcRootDoc, RootDoc viewRootDoc) Builds the views according to the parameters on the command line
static Options	getCommentOptions()
static LanguageVersion	languageVersion() Indicate the language version we support
static void	main(java.lang.String[] args)
static int	optionLength(java.lang.String option) Option checking
static boolean	start(RootDoc root) Entry point through javadoc

Methods inherited from class java.lang.Object

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

Constructor Detail

UmlGraph

public UmlGraph()

Method Detail

start

public static boolean start(RootDoc root)
                     throws java.io.IOException

Entry point through javadoc

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

getCommentOptions

public static Options getCommentOptions()

buildOptions

public static Options buildOptions(RootDoc root)

Creates the base Options object. This contains both the options specified on the command line and the ones specified in the UMLOptions class, if available. Also create the globally accessible commentOptions object.

buildGraph

public static void buildGraph(RootDoc root,
              OptionProvider op,
              Doc contextDoc)
                       throws java.io.IOException

Builds and outputs a single graph according to the view overrides

Throws:

java.io.IOException

buildViews

public static View[] buildViews(Options opt,
                RootDoc srcRootDoc,
                RootDoc viewRootDoc)

Builds the views according to the parameters on the command line

Parameters:

opt - The options

srcRootDoc - The RootDoc for the source classes

viewRootDoc - The RootDoc for the view classes (may be different, or may be the same as the srcRootDoc)

optionLength

public static int optionLength(java.lang.String option)

Option checking

languageVersion

public static LanguageVersion languageVersion()

Indicate the language version we support