From b77d5a9eb6d22ce2b38a863e26af2065aae4c2b9 Mon Sep 17 00:00:00 2001 From: Andrea Aime Date: Mon, 2 Jan 2006 14:03:52 +0000 Subject: [PATCH] Added javadoc comments Added a couple of methods to manage view inheritance --- .../umlgraph/doclet/OptionProvider.java | 23 +++++++++++++++++++ src/org/umlgraph/doclet/OptionProvider.java | 23 +++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/src/gr/spinellis/umlgraph/doclet/OptionProvider.java b/src/gr/spinellis/umlgraph/doclet/OptionProvider.java index 69aba79..61155af 100644 --- a/src/gr/spinellis/umlgraph/doclet/OptionProvider.java +++ b/src/gr/spinellis/umlgraph/doclet/OptionProvider.java @@ -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); } diff --git a/src/org/umlgraph/doclet/OptionProvider.java b/src/org/umlgraph/doclet/OptionProvider.java index 69aba79..61155af 100644 --- a/src/org/umlgraph/doclet/OptionProvider.java +++ b/src/org/umlgraph/doclet/OptionProvider.java @@ -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); }