[FOray-commit] SF.net SVN: foray: [8706] trunk/foray

[<vic...@us...>]

Revision: 8706
          http://svn.sourceforge.net/foray/?rev=8706&view=rev
Author:   victormote
Date:     2007-02-13 20:53:26 -0800 (Tue, 13 Feb 2007)

Log Message:
-----------
Javadoc improvements.

Modified Paths:
--------------
    trunk/foray/doc/web/app/using/release.html
    trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java
    trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java
    trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java
    trunk/foray/foray-app/src/java/org/foray/app/FOray.java
    trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java
    trunk/foray/foray-app/src/java/org/foray/app/Options.java
    trunk/foray/foray-app/src/java/org/foray/app/OutputTargetFactory.java
    trunk/foray/foray-app/src/java/org/foray/app/PrintStarter.java
    trunk/foray/foray-app/src/java/org/foray/app/Starter.java
    trunk/foray/scripts/checkstyle-suppressions.xml

Modified: trunk/foray/doc/web/app/using/release.html
===================================================================
--- trunk/foray/doc/web/app/using/release.html	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/doc/web/app/using/release.html	2007-02-14 04:53:26 UTC (rev 8706)
@@ -50,8 +50,8 @@
   <li>The class org.foray.common.StringUtilPre5 has been removed, and uses of
   its methods have been replaced by standar Java 5.0 String and Character
   methods.</li>
-  <li>Completion of javadoc API documentation for the FOrayGraphic and
-  FOrayHyphen-R modules.</li>
+  <li>Completion of javadoc API documentation for the FOrayGraphic,
+  FOrayHyphen-R, FOrayApp, and FOrayCore modules.</li>
   <li>The FOrayGraphicServer constructor no longer requires the name of the
   parser class as a parameter.</li>
 </ul>

Modified: trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -62,16 +62,33 @@
  */
 public class AWTStarter extends CommandLineStarter {
 
+    /** Path to the viewer resources. */
     private static final String TRANSLATION_PATH =
         "/org/foray/render/awt/viewer/resources/";
 
+    /** The preview dialog. */
     private PreviewDialog frame;
+
+    /** The renderer. */
     private AWTRenderer renderer;
+
+    /** The FOray document. */
     private FOrayDocument document;
 
+    /** The translator. */
     private Translator resource;
+
+    /** The current user message. */
     private UserMessage userMessage;
 
+    /**
+     * Constructor.
+     * @param logger The logger.
+     * @param sessionConfig The session configuration.
+     * @param renderConfig The output configuration.
+     * @param commandLineOptions The command-line options.
+     * @throws FOrayException For errors during construction.
+     */
     public AWTStarter(final Log logger, final SessionConfig sessionConfig,
             final OutputConfig renderConfig,
             final CommandLineOptions commandLineOptions) throws FOrayException {
@@ -79,6 +96,10 @@
         init();
     }
 
+    /**
+     * Initializes the starter.
+     * @throws FOrayException For errors during initialization.
+     */
     private void init() throws FOrayException {
         this.userMessage = new UserMessage(getLogger());
         try {
@@ -116,6 +137,9 @@
         frame.progress(resource.getString("Init parser") + " ...");
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void run() throws FOrayException {
         // build FO tree: time
         frame.progress(resource.getString("Build FO tree") + " ...");
@@ -132,6 +156,12 @@
         frame.showPage();
     }
 
+    /**
+     * Creates a new preview dialog.
+     * @param renderer The rendere.
+     * @param res The language resources.
+     * @return The newly-created preview dialog.
+     */
     protected PreviewDialog createPreviewDialog(final AWTRenderer renderer,
             final Translator res) {
         final PreviewDialog frame = new PreviewDialog(renderer, res,
@@ -160,7 +190,11 @@
     }
 
 
-
+    /**
+     * Gets a secure resource bundle.
+     * @param path The path to the bundle.
+     * @return The secure resource bundle.
+     */
     private SecureResourceBundle getResourceBundle(final String path) {
         InputStream in = null;
 

Modified: trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -59,6 +59,8 @@
     /** Constant indicating that the input is XML + XSLT. */
     public static final int INPUT_XSLT = 2;
 
+    /** The number of command-line arguments needed to specify standard options,
+     * that is, one for the "-so", one for the key, and one for the value. */
     private static final int STANDARD_OPTIONS_QTY_ARGUMENTS = 3;
 
     /** The user configuration file. */
@@ -85,14 +87,25 @@
     /** Language for user information. */
     private String language = null;
 
+    /** The session configuration. */
     private SessionConfig sessionConfig;
+
+    /** The output configuration. */
     private OutputConfig rendererOptions;
 
+    /** The logger. */
     private Log log;
 
     /** State variable indicating current index into args[]. */
     private transient int currentArgument = 0;
 
+    /**
+     * Constructor.
+     * @param args The command-line arguments.
+     * @param logger The logger.
+     * @throws FOrayException For errors parsing options.
+     * @throws FileNotFoundException For errors finding specified files.
+     */
     public CommandLineOptions(final String[] args, final Log logger)
             throws FOrayException, FileNotFoundException {
         this.log = logger;
@@ -116,17 +129,21 @@
         }
     }
 
+    /**
+     * Sets the loggers verbosity, based on the command-line options.
+     */
     private void adjustLogger() {
         final String verbosity = this.sessionConfig.optionVerbosity();
         if (verbosity.equals("debug")) {
-            setLogger(Logging.makeDebugLogger());
+            this.log = Logging.makeDebugLogger();
         } else if (verbosity.equals("quiet")) {
-            setLogger(Logging.makeQuietLogger());
+            this.log = Logging.makeQuietLogger();
         }
     }
 
     /**
      * Parses the commandline arguments.
+     * @param args The command-line arguments to parse.
      * @return true if parse was successful and procesing can continue, false
      * if processing should stop.
      * @throws FOrayException if there was an error in the format of the
@@ -340,6 +357,9 @@
     /**
      * Parses a configuration option.
      * @param args The command-line arguments.
+     * @return True iff the option was successfully parsed.
+     * @throws FOrayException If the option is not in the expected key-value
+     * pair.
      */
     private boolean parseConfigurationOption(final String[] args)
             throws FOrayException {
@@ -362,6 +382,11 @@
                 OutputConfig.PRECEDENCE_COMMAND_LINE);
     }
 
+    /**
+     * Sets the output mode.
+     * @param mode The new output mode to set.
+     * @throws FOrayException If the output mode has already been set.
+     */
     private void setOutputMode(final int mode) throws FOrayException {
         if (outputmode == INPUT_NOT_SET) {
             outputmode = mode;
@@ -373,6 +398,8 @@
     /**
      * Checks whether all necessary information has been given in a consistent
      * way.
+     * @throws FOrayException For FOray inconsistencies.
+     * @throws FileNotFoundException For specified files that do not exist.
      */
     private void checkSettings() throws FOrayException, FileNotFoundException {
         if (inputmode == INPUT_NOT_SET) {
@@ -423,12 +450,12 @@
             }
 
         }
-    }    // end checkSettings
-
-    private void setLogger(final Log newLogger) {
-        this.log = newLogger;
     }
 
+//    private void setLogger(final Log newLogger) {
+//        this.log = newLogger;
+//    }
+
     /**
      * Returns the output type specifiedon the command-line.
      * @return The integer representing a Renderer type.
@@ -441,6 +468,8 @@
 
     /**
      * Provides the input source representing the command-line options.
+     * @return The input source.
+     * @throws FOrayException For errors creaing the input source.
      */
     public InputSource getInputSource() throws FOrayException {
         if (inputmode == INPUT_FO) {
@@ -453,14 +482,27 @@
         return null;
     }
 
+    /**
+     * Returns the renderer options.
+     * @return The renderer options.
+     */
     public OutputConfig getRendererOptions() {
         return this.rendererOptions;
     }
 
+    /**
+     * Returns the session configuration.
+     * @return The session configuration.
+     */
     public SessionConfig getSessionConfig() {
         return this.sessionConfig;
     }
 
+    /**
+     * Returns the starter to use for starting the application.
+     * @return The starter to use to start the application.
+     * @throws FOrayException For errors creating the starter.
+     */
     public Starter getStarter() throws FOrayException {
         Starter starter = null;
         switch (outputmode) {
@@ -494,34 +536,66 @@
         return starter;
     }
 
+    /**
+     * Returns the parsed input mode.
+     * @return The parsed inlput mode.
+     */
     public int getInputMode() {
         return inputmode;
     }
 
+    /**
+     * Returns the parsed output mode.
+     * @return The parsed output mode.
+     */
     public int getOutputMode() {
         return outputmode;
     }
 
+    /**
+     * Returns the parsed FO file location.
+     * @return The parsed FO file location.
+     */
     public URL getFOFile() {
         return foInput;
     }
 
+    /**
+     * Returns the parsed XML file location.
+     * @return The parsed XML file location.
+     */
     public URL getXMLFile() {
         return xmlInput;
     }
 
+    /**
+     * Returns the parsed XSLT stylesheet file location.
+     * @return The parsed XSLT stylesheet file location.
+     */
     public URL getXSLFile() {
         return xsltInput;
     }
 
+    /**
+     * Returns the parsed output file location.
+     * @return The parsed output file location.
+     */
     public File getOutputFile() {
         return outfile;
     }
 
+    /**
+     * Returns the parsed user configuration file location.
+     * @return The parsed user configuration file location.
+     */
     public URL getUserConfigFile() {
         return userConfig;
     }
 
+    /**
+     * Returns the parsed language.
+     * @return The parsed language.
+     */
     public String getLanguage() {
         return language;
     }
@@ -543,6 +617,7 @@
     /**
      * Shows the commandline syntax including a summary of all available
      * options and some examples.
+     * @param logger The logger on which to print the message.
      */
     public static void printUsage(final Log logger) {
         logger.error("\nUSAGE\nFOray [options] [-fo|-xml] infile "

Modified: trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -50,8 +50,17 @@
  */
 public class CommandLineStarter extends Starter {
 
+    /** The command-line options. */
     private CommandLineOptions commandLineOptions;
 
+    /**
+     * Constructor.
+     * @param logger The logger.
+     * @param sessionConfig The session configuration.
+     * @param outputConfig The output configuratiion.
+     * @param commandLineOptions The command-line options.
+     * @throws FOrayException For errors during construction.
+     */
     public CommandLineStarter(final Log logger,
             final SessionConfig sessionConfig, final OutputConfig outputConfig,
             final CommandLineOptions commandLineOptions)
@@ -63,8 +72,7 @@
     }
 
     /**
-     * Run the format.
-     * @exception FOrayException if there is an error during processing
+     * {@inheritDoc}
      */
     public void run() throws FOrayException {
         /*
@@ -187,6 +195,11 @@
         target.cleanup();
     }
 
+    /**
+     * Returns the file output stream.
+     * @return The output stream.
+     * @throws FOrayException If the file is not found.
+     */
     private FileOutputStream getFileOutputStream() throws FOrayException {
         final File outputFile = commandLineOptions.getOutputFile();
         try {

Modified: trunk/foray/foray-app/src/java/org/foray/app/FOray.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/FOray.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/FOray.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -49,6 +49,8 @@
 
     /**
      * Main command-line entry point to FOray.
+     * @param args The command-line arguments. See the application documentation
+     * for details on these arguments.
      */
     public static void main(final String[] args) {
         CommandLineOptions options = null;

Modified: trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -65,6 +65,10 @@
  */
 public final class FOraySpecific {
 
+    /** The number of items in a standard FOray graphic search path, that is,
+     * one for the base document location (current directory of the fo file),
+     * one for the base directory, and one for the system property
+     * "user.dir". */
     private static final int STANDARD_GRAPHIC_SEARCH_ELEMENTS = 3;
 
     /**
@@ -76,6 +80,7 @@
     /**
      * Creates a new FOraySession instance configured with default servers and
      * factories.
+     * @param sessionConfig The session configuration.
      * @return The newly-created FOraySession.
      * @throws FOrayException For errors in creating the server and factories,
      * or in instantiating the FOraySession.
@@ -103,6 +108,11 @@
         return session;
     }
 
+    /**
+     * Make a standard logger for use in FOray.
+     * @param configuration The session configuration.
+     * @return The newly-created logger.
+     */
     public static Log makeLogger(final SessionConfig configuration) {
         if (configuration.optionVerbosity().equals("debug")) {
             return Logging.makeDebugLogger();
@@ -111,6 +121,13 @@
         }
     }
 
+    /**
+     * Make a standard FontServer instance for use in FOray.
+     * @param logger The logger.
+     * @param configuration The session configuration.
+     * @return The newly-created FontServer instance.
+     * @throws FOrayException For errors creating the server.
+     */
     public static FontServer makeFontServer(final Log logger,
             final SessionConfig configuration) throws FOrayException {
         final EntityResolver entityResolver = makeEntityResolver(configuration);
@@ -128,11 +145,25 @@
         return forayFontServer;
     }
 
+    /**
+     * Make a standard TextServer instance for use in FOray.
+     * @param logger The logger.
+     * @param hyphenServer The hyphenation server to be used in line-breaking
+     * decisions.
+     * @return The newly-created TextServer instance.
+     * @throws FOrayException For errors creating the server.
+     */
     public static TextServer makeTextServer(final Log logger,
             final HyphenationServer hyphenServer) throws FOrayException {
         return new org.foray.text.TextServer(logger, hyphenServer);
     }
 
+    /**
+     * Make a standard HyphenationServer instance for use in FOray.
+     * @param logger The logger.
+     * @param configuration The session configuration.
+     * @return The newly-created HyphenationServer instance.
+     */
     public static HyphenationServer makeHyphenationServer(final Log logger,
             final SessionConfig configuration) {
         final URL hyphenationDir =
@@ -141,11 +172,26 @@
                 hyphenationDir);
     }
 
+    /**
+     * Make a standard GraphicServer instance for use in FOray.
+     * @param logger The logger.
+     * @return The newly-created GraphicServer instance.
+     * @throws FOrayException For errors creating the server.
+     */
     public static GraphicServer makeGraphicServer(final Log logger)
             throws FOrayException {
         return new FOrayGraphicServer(logger);
     }
 
+    /**
+     * Make a standard FOTreeFactory instance for use in FOray.
+     * @param logger The logger.
+     * @param configuration The session configuration.
+     * @param graphicServer The GraphicServer instance to use.
+     * @param textServer The TextServer to use.
+     * @return The newly-created FOTreeFactory instance.
+     * @throws FOrayException For errors creating the server.
+     */
     public static FOTreeFactory makeFOTreeFactory(final Log logger,
             final SessionConfig configuration,
             final GraphicServer graphicServer, final TextServer textServer)
@@ -155,6 +201,11 @@
                 graphicSearchPath, configuration.optionCacheGraphics());
     }
 
+    /**
+     * Create a standard graphic search path for use in FOray.
+     * @param configuration The session configuration.
+     * @return The standard graphic search path.
+     */
     private static URL[] buildGraphicSearchPath(
             final SessionConfig configuration) {
         final URL[] urls = new URL[STANDARD_GRAPHIC_SEARCH_ELEMENTS];
@@ -168,16 +219,35 @@
         return urls;
     }
 
+    /**
+     * Make a standard AreaTreeFactory instance for use in FOray.
+     * @param logger The logger.
+     * @param textServer The TextServer to use.
+     * @return The newly-created AreaTreeFactory instance.
+     * @throws FOrayException For errors creating the server.
+     */
     public static AreaTreeFactory makeAreaTreeFactory(final Log logger,
             final TextServer textServer) throws FOrayException {
         return new FOrayAreaTreeFactory(logger, textServer);
     }
 
+    /**
+     * Make a standard LayoutFactory instance for use in FOray.
+     * @param logger The logger.
+     * @return The newly-created LayoutFactory instance.
+     * @throws FOrayException For errors creating the server.
+     */
     public static LayoutFactory makeLayoutFactory(final Log logger)
             throws FOrayException {
         return new PioneerFactory(logger);
     }
 
+    /**
+     * Create a standard entity resolver for use with FOray.
+     * @param configuration The session configuration.
+     * @return The newly-created entity resolver, or null if no XML catalog
+     * is specified.
+     */
     public static EntityResolver makeEntityResolver(
             final SessionConfig configuration) {
         final String catalog = configuration.optionXMLCatalog();

Modified: trunk/foray/foray-app/src/java/org/foray/app/Options.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/Options.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/Options.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -46,12 +46,22 @@
  */
 public class Options {
 
+    /** The session configuration. */
     private SessionConfig sessionConfig;
+
+    /** The output configuration. */
     private OutputConfig renderConfig;
 
     /** The logger that should be used. */
     private Log logger;
 
+    /**
+     * Constructor for case when the user configuration file is not known.
+     * @param logger The logger.
+     * @param sessionConfig The session configuration.
+     * @param renderConfig The output configuration.
+     * @throws FOrayException For errors during construction.
+     */
     public Options(final Log logger, final SessionConfig sessionConfig,
             final OutputConfig renderConfig) throws FOrayException {
         this.logger = logger;
@@ -59,6 +69,14 @@
         this.renderConfig = renderConfig;
     }
 
+    /**
+     * Constructor for case when the user configuration file is known.
+     * @param logger The logger.
+     * @param sessionConfig The session configuration.
+     * @param renderConfig The output configuration.
+     * @param userConfigFile The user configuration to be processed.
+     * @throws FOrayException For errors during construction.
+     */
     public Options(final Log logger, final SessionConfig sessionConfig,
             final OutputConfig renderConfig, final URL userConfigFile)
             throws FOrayException {
@@ -67,7 +85,9 @@
         initOptions();
     }
 
-    // initializing option settings
+    /**
+     * Initializes the option settings.
+     */
     void initOptions() {
         if (this.sessionConfig.optionDumpConfiguration()) {
             this.sessionConfig.dumpConfiguration();
@@ -75,7 +95,12 @@
         }
     }
 
-    // setting clOptions
+    /**
+     * Process the user configuration file from the command-line options.
+     * @param clOptions The command-line options whose user configuration should
+     * be processed.
+     * @throws FOrayException For errors during configuration processing.
+     */
     void setCommandLineOptions(final CommandLineOptions clOptions)
             throws FOrayException {
         // load user configuration file,if there is one
@@ -91,6 +116,12 @@
         }
     }
 
+    /**
+     * Loads a user configuration from a URL.
+     * @param userConfigFile The URL to be loaded.
+     * @throws FOrayException If the URL cannot be accessed, or if there are
+     * errors loading it.
+     */
     public void loadUserconfiguration(final URL userConfigFile)
             throws FOrayException {
         if (userConfigFile == null) {
@@ -105,6 +136,11 @@
         }
     }
 
+    /**
+     * Loades a user configuration from an InputSource.
+     * @param userConfigSource The input source to be processed.
+     * @throws FOrayException For errors processing the configuration.
+     */
     public void loadUserconfiguration(final InputSource userConfigSource)
             throws FOrayException {
         // read user configuration
@@ -123,22 +159,27 @@
     }
 
     /**
-     * Dumps an error in standard way.
+     * Logs an error in a standard way.
+     * @param exception The Exception to be logged.
      */
-    public void dumpError(final Exception e) {
+    public void dumpError(final Exception exception) {
         if (! getSessionConfig().optionVerbosity().equals("debug")) {
             return;
         }
-        if (e instanceof SAXException) {
-            e.printStackTrace();
-            if (((SAXException) e).getException() != null) {
-                ((SAXException) e).getException().printStackTrace();
+        if (exception instanceof SAXException) {
+            exception.printStackTrace();
+            if (((SAXException) exception).getException() != null) {
+                ((SAXException) exception).getException().printStackTrace();
             }
         } else {
-            e.printStackTrace();
+            exception.printStackTrace();
         }
     }
 
+    /**
+     * Returns the session configuration.
+     * @return The session configuration.
+     */
     public SessionConfig getSessionConfig() {
         return this.sessionConfig;
     }

Modified: trunk/foray/foray-app/src/java/org/foray/app/OutputTargetFactory.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/OutputTargetFactory.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/OutputTargetFactory.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -100,6 +100,9 @@
      * </ul>
      * @param outputOptions Map containing the options to be used with the
      * Renderer.
+     * @param logger The logger.
+     * @return The newly-created OutputTarget instance.
+     * @throws FOrayException For errors creating the target.
      */
     public static OutputTarget makeOutputTarget(final int rendererType,
             final OutputConfig outputOptions, final Log logger)
@@ -191,6 +194,12 @@
         return -1;
     }
 
+    /**
+     * Returns the mime extension for a given renderer type.
+     * @param rendererType The renderer type for which the mime extension is
+     * needed.
+     * @return The mime extension.
+     */
     public static String getMimeExtension(final int rendererType) {
         switch (rendererType) {
         case RENDER_PDF: {

Modified: trunk/foray/foray-app/src/java/org/foray/app/PrintStarter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/PrintStarter.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/PrintStarter.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -52,12 +52,23 @@
  */
 public class PrintStarter extends CommandLineStarter {
 
+    /**
+     * Constructor.
+     * @param logger The logger.
+     * @param sessionConfig The session configuration.
+     * @param renderConfig The output configuration.
+     * @param options The options.
+     * @throws FOrayException For errors during construction.
+     */
     public PrintStarter(final Log logger, final SessionConfig sessionConfig,
             final OutputConfig renderConfig, final CommandLineOptions options)
             throws FOrayException {
         super(logger, sessionConfig, renderConfig, options);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void run() throws FOrayException {
         final SessionConfig configuration = getOptions().getSessionConfig();
         final FOraySession session = FOraySpecific.makeFOraySession(
@@ -84,6 +95,13 @@
         System.exit(0);
     }
 
+    /**
+     * Returns an integer property value.
+     * @param name The name of the property whose value is needed.
+     * @param def The default value for the property.
+     * @return The property value if it is found, or <code>def</code> if it is
+     * not found.
+     */
     int getIntProperty(final String name, final int def) {
         final String propValue = System.getProperty(name);
         if (propValue != null) {

Modified: trunk/foray/foray-app/src/java/org/foray/app/Starter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/Starter.java	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/foray-app/src/java/org/foray/app/Starter.java	2007-02-14 04:53:26 UTC (rev 8706)
@@ -37,17 +37,29 @@
 import org.xml.sax.InputSource;
 
 /**
- * abstract super class
- * Creates a SAX Parser (defaulting to Xerces).
- *
+ * Abstract super class for all FOray starters.
  */
 public abstract class Starter {
 
+    /** The options instance. */
     private Options options;
+
+    /** The input source. */
     private InputSource inputSource;
+
+    /** The logger. */
     private Log logger;
+
+    /** The output configuration. */
     private OutputConfig outputConfig;
 
+    /**
+     * Constructor.
+     * @param logger The logger.
+     * @param sessionConfig The session configuration.
+     * @param renderConfig The output configuration.
+     * @throws FOrayException For errors durint construction.
+     */
     public Starter(final Log logger, final SessionConfig sessionConfig,
             final OutputConfig renderConfig) throws FOrayException {
         this.logger = logger;
@@ -55,12 +67,24 @@
         options = new Options(logger, sessionConfig, renderConfig);
     }
 
+    /**
+     * Sets the input source to be used for processing.
+     * @param inputSource The new input source.
+     */
     public void setInputSource(final InputSource inputSource) {
         this.inputSource = inputSource;
     }
 
+    /**
+     * Runs the process.
+     * @throws FOrayException For errors during processing.
+     */
     public abstract void run() throws FOrayException;
 
+    /**
+     * Returns the logger.
+     * @return The logger.
+     */
     public Log getLogger() {
         return this.logger;
     }

Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml	2007-02-14 03:56:15 UTC (rev 8705)
+++ trunk/foray/scripts/checkstyle-suppressions.xml	2007-02-14 04:53:26 UTC (rev 8706)
@@ -8,10 +8,6 @@
 
   <!-- Suppress partially-implemented checks where not yet implemented. -->
 
-  <suppress checks="Javadoc[MV].*"
-      files="org.foray.app.*"/>
-  <suppress checks="Javadoc[MV].*"
-      files="org.foray.demo.*"/>
   <suppress checks="Javadoc[MVS].*"
       files="org.foray.area.*"/>
   <suppress checks="Javadoc[MVS].*"


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.