geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jdil...@apache.org
Subject svn commit: r417099 - /geronimo/sandbox/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandSupport.java
Date Mon, 26 Jun 2006 00:54:18 GMT
Author: jdillon
Date: Sun Jun 25 17:54:18 2006
New Revision: 417099

URL: http://svn.apache.org/viewvc?rev=417099&view=rev
Log:
Javadocs

Modified:
    geronimo/sandbox/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandSupport.java

Modified: geronimo/sandbox/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandSupport.java
URL: http://svn.apache.org/viewvc/geronimo/sandbox/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandSupport.java?rev=417099&r1=417098&r2=417099&view=diff
==============================================================================
--- geronimo/sandbox/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandSupport.java
(original)
+++ geronimo/sandbox/gshell/trunk/gshell-api/src/main/java/org/apache/geronimo/gshell/command/CommandSupport.java
Sun Jun 25 17:54:18 2006
@@ -285,6 +285,9 @@
     /**
      * Process the command-line.
      *
+     * <p>
+     * The default is to provide no additional processing.
+     *
      * @param line  The command-line to process.
      * @return      True to display help and exit; else false to continue.
      *
@@ -294,6 +297,14 @@
         return false;
     }
 
+    /**
+     * Get the command-line options to process.
+     *
+     * <p>
+     * The default is to provide --help and -h support.
+     *
+     * @return  The command-line options; never null;
+     */
     protected Options getOptions() {
         MessageSource messages = getMessageSource();
 
@@ -306,6 +317,11 @@
         return options;
     }
 
+    /**
+     * Returns the command-line usage.
+     *
+     * @return  The command-line usage.
+     */
     protected String getUsage() {
         return "[options]";
     }



Mime
View raw message