[FOray-commit] SF.net SVN: foray: [8469] trunk/foray/foray-app/src/java/org/foray/app

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

Revision: 8469
          http://svn.sourceforge.net/foray/?rev=8469&view=rev
Author:   victormote
Date:     2007-01-20 16:14:11 -0800 (Sat, 20 Jan 2007)

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

Modified Paths:
--------------
    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/FOraySpecific.java
    trunk/foray/foray-app/src/java/org/foray/app/Options.java
    trunk/foray/foray-app/src/java/org/foray/app/Starter.java
    trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTask.java
    trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java

Modified: trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/AWTStarter.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -58,7 +58,7 @@
 import javax.swing.UIManager;
 
 /**
- * initialize AWT previewer
+ * Starter for the AWT viewer.
  */
 public class AWTStarter extends CommandLineStarter {
 

Modified: trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -46,7 +46,7 @@
 import java.net.URL;
 
 /**
- * Options parses the commandline arguments
+ * Parses the commandline arguments.
  */
 public class CommandLineOptions {
 
@@ -82,7 +82,7 @@
     /** The output mode. */
     private int outputmode = INPUT_NOT_SET;
 
-    /** Language for user information */
+    /** Language for user information. */
     private String language = null;
 
     private SessionConfig sessionConfig;
@@ -126,10 +126,10 @@
     }
 
     /**
-     * parses the commandline arguments
+     * Parses the commandline arguments.
      * @return true if parse was successful and procesing can continue, false
      * if processing should stop.
-     * @exception FOrayException if there was an error in the format of the
+     * @throws FOrayException if there was an error in the format of the
      * options.
      */
     private boolean parseOptions(final String args[]) throws FOrayException {
@@ -146,9 +146,10 @@
     }
 
     /**
-     * @param args
+     * Parses one command-line option.
+     * @param args The command-line arguments.
      * @return True if the option was successfully parsed, false otherwise.
-     * @throws FOrayException
+     * @throws FOrayException For errors in the options.
      */
     private boolean parseOneOption(final String[] args) throws FOrayException {
         if (args[currentArgument].equals("-c")) {
@@ -337,7 +338,8 @@
     }
 
     /**
-     * @param args
+     * Parses a configuration option.
+     * @param args The command-line arguments.
      */
     private boolean parseConfigurationOption(final String[] args)
             throws FOrayException {
@@ -369,8 +371,8 @@
     }
 
     /**
-     * checks whether all necessary information has been given in a consistent
-     * way
+     * Checks whether all necessary information has been given in a consistent
+     * way.
      */
     private void checkSettings() throws FOrayException, FileNotFoundException {
         if (inputmode == INPUT_NOT_SET) {
@@ -428,6 +430,7 @@
     }
 
     /**
+     * Returns the output type specifiedon the command-line.
      * @return The integer representing a Renderer type.
      * @throws FOrayException if the output mode cannot be mapped to a Renderer
      * type.
@@ -437,7 +440,7 @@
     }
 
     /**
-     *
+     * Provides the input source representing the command-line options.
      */
     public InputSource getInputSource() throws FOrayException {
         if (inputmode == INPUT_FO) {
@@ -538,8 +541,8 @@
 //    }
 
     /**
-     * shows the commandline syntax including a summary of all available
-     * options and some examples
+     * Shows the commandline syntax including a summary of all available
+     * options and some examples.
      */
     public static void printUsage(final Log logger) {
         logger.error("\nUSAGE\nFOray [options] [-fo|-xml] infile "
@@ -591,7 +594,7 @@
     }
 
     /**
-     * shows the options for print output
+     * Shows the options for print output.
      */
     public void printUsagePrintOutput() {
         log.error("USAGE: -print [-Dstart=i] [-Dend=i] [-Dcopies=i] "

Modified: trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/CommandLineStarter.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -197,6 +197,7 @@
     }
 
     /**
+     * Returns the parsed command-line options.
      * @return Returns the commandLineOptions.
      */
     public CommandLineOptions getCommandLineOptions() {

Modified: trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -75,8 +75,9 @@
     }
 
     /**
-     * @return A new FOraySession instance configured with default servers and
+     * Creates a new FOraySession instance configured with default servers and
      * factories.
+     * @return The newly-created FOraySession.
      * @throws FOrayException For errors in creating the server and factories,
      * or in instantiating the FOraySession.
      */

Modified: trunk/foray/foray-app/src/java/org/foray/app/Options.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/Options.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/Options.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -42,8 +42,7 @@
 import java.net.URL;
 
 /**
- * Options handles loading of configuration files and
- * additional setting of commandline options
+ * Loads configuration files and additional setting of commandline options.
  */
 public class Options {
 
@@ -124,7 +123,7 @@
     }
 
     /**
-     * Dumps an error
+     * Dumps an error in standard way.
      */
     public void dumpError(final Exception e) {
         if (! getSessionConfig().optionVerbosity().equals("debug")) {

Modified: trunk/foray/foray-app/src/java/org/foray/app/Starter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/Starter.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/Starter.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -66,6 +66,7 @@
     }
 
     /**
+     * Returns the output configuration.
      * @return Returns the outputConfig.
      */
     public OutputConfig getOutputConfig() {
@@ -73,6 +74,7 @@
     }
 
     /**
+     * Returns the options.
      * @return Returns the options.
      */
     public Options getOptions() {
@@ -80,6 +82,7 @@
     }
 
     /**
+     * Returns the input source.
      * @return Returns the inputSource.
      */
     public InputSource getInputSource() {

Modified: trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTask.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTask.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTask.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -91,7 +91,7 @@
     }
 
     /**
-     * Gets the input file
+     * Gets the input file.
      */
     public File getFofile() {
         return foFile;
@@ -115,15 +115,15 @@
     }
 
     /**
-     * Gets the force attribute
-     * @return the force attribute
+     * Gets the force attribute.
+     * @return The force attribute.
      */
     public boolean getForce() {
         return force;
     }
 
     /**
-     * Sets the output file
+     * Sets the output file.
      * @param outFile The File to which the output should be written.
      */
     public void setOutfile(final File outFile) {
@@ -131,14 +131,14 @@
     }
 
     /**
-     * Gets the output file
+     * Gets the output file.
      */
     public File getOutfile() {
         return this.outFile;
     }
 
     /**
-     * Sets the output directory
+     * Sets the output directory.
      * @param outDir Directory to which the output should be written.
      */
     public void setOutdir(final File outDir) {
@@ -146,21 +146,21 @@
     }
 
     /**
-     * Gets the output directory
+     * Gets the output directory.
      */
     public File getOutdir() {
         return this.outDir;
     }
 
     /**
-     * Sets output format (MIME type)
+     * Sets output format (MIME type).
      */
     public void setFormat(final String format) {
         this.format = format;
     }
 
     /**
-     * Gets the output format (MIME type)
+     * Gets the output format (MIME type).
      */
     public String getFormat() {
         return this.format;
@@ -207,7 +207,7 @@
     }
 
     /**
-     * Gets the base directory
+     * Gets the base directory.
      */
     public File getBasedir() {
         return (baseDir != null) ? baseDir : getProject().resolveFile(".");
@@ -226,7 +226,7 @@
     }
 
     /**
-     * Starts execution of this task
+     * Starts execution of this task.
      */
     public void execute() {
         Log log = null;
@@ -277,14 +277,16 @@
     }
 
     /**
-     * @return Returns the filesets.
+     * Returns the filesets.
+     * @return The filesets.
      */
     public List getFilesets() {
         return this.filesets;
     }
 
     /**
-     * @return Returns the userConfig.
+     * Returns the URL of the user configuration.
+     * @return The user configuration.
      */
     public URL getUserConfig() {
         return this.userConfig;

Modified: trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java	2007-01-20 23:48:07 UTC (rev 8468)
+++ trunk/foray/foray-app/src/java/org/foray/app/ant/FOrayAntTaskStarter.java	2007-01-21 00:14:11 UTC (rev 8469)
@@ -68,7 +68,7 @@
     /** Number of fofiles actually processed. */
     private int actioncount = 0;
 
-    /** Numer of fofiles skipped because they haven't changed (force = "false")
+    /** Numer of fofiles skipped because they haven't changed (force = "false").
      */
     private int skippedcount = 0;
 
@@ -126,10 +126,10 @@
     }
 
     /**
-     * @throws FOrayException
+     * Process one file.
+     * @throws FOrayException For errors during file processing.
      */
-    private void processFile()
-            throws FOrayException {
+    private void processFile() throws FOrayException {
         if (task.getFofile() == null) {
             return;
         }
@@ -158,7 +158,8 @@
     }
 
     /**
-     * @throws FOrayException
+     * Process a fileset.
+     * @throws FOrayException For errors during processing.
      */
     private void processFileSet()
             throws FOrayException {
@@ -227,6 +228,7 @@
     }
 
     /**
+     * Computes and sets tehe base directory if needed.
      */
     private void setBaseDirectory() {
         if (task.getFofile() == null) {


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