Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Watson2010-04-30 12:08:34 -0400
committerThomas Watson2010-04-30 12:08:34 -0400
commit69a795e41f45601f16922374ba411aa88fb2d78a (patch)
tree52dfeff32565fa1d69fa5b5b82f82b8939333686 /bundles/org.eclipse.osgi
parentf25751db06a557e0c16a5165044f69166a017226 (diff)
downloadrt.equinox.framework-69a795e41f45601f16922374ba411aa88fb2d78a.tar.gz
rt.equinox.framework-69a795e41f45601f16922374ba411aa88fb2d78a.tar.xz
rt.equinox.framework-69a795e41f45601f16922374ba411aa88fb2d78a.zip
javadoc fixes.
Diffstat (limited to 'bundles/org.eclipse.osgi')
-rw-r--r--bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/CommandInterpreter.java19
1 files changed, 10 insertions, 9 deletions
diff --git a/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/CommandInterpreter.java b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/CommandInterpreter.java
index 213b81459..52784ca6e 100644
--- a/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/CommandInterpreter.java
+++ b/bundles/org.eclipse.osgi/core/framework/org/eclipse/osgi/framework/console/CommandInterpreter.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2003, 2008 IBM Corporation and others.
+ * Copyright (c) 2003, 2010 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -26,18 +26,19 @@ import org.osgi.framework.Bundle;
*/
public interface CommandInterpreter {
/**
- * Get the next argument in the input.
- *
- * E.g. if the commandline is hello world, the _hello method
- * will get "world" as the first argument.
+ * Get the next argument in the input. If no arguments are left then null is returned.
+ *
+ * E.g. if the commandline is hello world, the _hello method
+ * will get "world" as the first argument.
+ * @return the next argument or null if no arguments are left.
*/
public String nextArgument();
/**
- * Execute a command line as if it came from the end user
- * and return the result.
- *
- * Throws any exceptions generated by the command that executed.
+ * Execute a command line as if it came from the end user
+ * and return the result.
+ * @param The command line to execute.
+ * @return the result of the command.
*/
public Object execute(String cmd);

Back to the top