Added javadoc comments

Added a couple of methods to manage view inheritance
This commit is contained in:
Andrea Aime 2006-01-02 14:03:52 +00:00
parent 646a4d5280
commit b77d5a9eb6
2 changed files with 46 additions and 0 deletions

View File

@ -2,10 +2,33 @@ package gr.spinellis.umlgraph.doclet;
import com.sun.javadoc.ClassDoc;
/**
* A factory class that builds Options object for general use or for a
* specific class
*/
public interface OptionProvider {
/**
* Returns the options for the specified class.
*/
public Options getOptionsFor(ClassDoc cd);
/**
* Returns the options for the specified class.
*/
public Options getOptionsFor(String name);
/**
* Returns the global options (the class independent definition)
*/
public Options getGlobalOptions();
/**
* Gets a base Options and applies the overrides for the specified class
*/
public void overrideForClass(Options opt, ClassDoc cd);
/**
* Gets a base Options and applies the overrides for the specified class
*/
public void overrideForClass(Options opt, String className);
}

View File

@ -2,10 +2,33 @@ package gr.spinellis.umlgraph.doclet;
import com.sun.javadoc.ClassDoc;
/**
* A factory class that builds Options object for general use or for a
* specific class
*/
public interface OptionProvider {
/**
* Returns the options for the specified class.
*/
public Options getOptionsFor(ClassDoc cd);
/**
* Returns the options for the specified class.
*/
public Options getOptionsFor(String name);
/**
* Returns the global options (the class independent definition)
*/
public Options getGlobalOptions();
/**
* Gets a base Options and applies the overrides for the specified class
*/
public void overrideForClass(Options opt, ClassDoc cd);
/**
* Gets a base Options and applies the overrides for the specified class
*/
public void overrideForClass(Options opt, String className);
}