svn commit: r417113 - /geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/commandline/CommandLine.java

[jd...@apache.org]

Author: jdillon
Date: Sun Jun 25 19:20:31 2006
New Revision: 417113

URL: http://svn.apache.org/viewvc?rev=417113&view=rev
Log:
Javadoc

Modified:
    geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/commandline/CommandLine.java

Modified: geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/commandline/CommandLine.java
URL: http://svn.apache.org/viewvc/geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/commandline/CommandLine.java?rev=417113&r1=417112&r2=417113&view=diff
==============================================================================
--- geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/commandline/CommandLine.java (original)
+++ geronimo/sandbox/gshell/trunk/gshell-core/src/main/java/org/apache/geronimo/gshell/commandline/CommandLine.java Sun Jun 25 19:20:31 2006
@@ -17,11 +17,21 @@
 package org.apache.geronimo.gshell.commandline;
 
 /**
- * A generic abstraction of an executable command-line.
+ * A abstraction of an executable command-line.
+ *
+ * <p>
+ * Could be a simple command or a complex command pipe-line.
  *
  * @version $Id$
  */
 public interface CommandLine
 {
+    /**
+     * Execute the command-line.
+     *
+     * @return  The final result of the command-line.
+     *
+     * @throws Exception    Failed to execute command-line.
+     */
     Object execute() throws Exception;
 }