summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorkthoms2009-01-15 06:36:30 (EST)
committerkthoms2009-01-15 06:36:30 (EST)
commitb58045f5f16f4e43460680471b4f9516d2dd031e (patch)
tree09e04facdd3c6c51943887df5e97bad494f5c1fa
parent27987937e06a18300f998a1ef05436ca82937cb8 (diff)
downloadorg.eclipse.mwe-b58045f5f16f4e43460680471b4f9516d2dd031e.zip
org.eclipse.mwe-b58045f5f16f4e43460680471b4f9516d2dd031e.tar.gz
org.eclipse.mwe-b58045f5f16f4e43460680471b4f9516d2dd031e.tar.bz2
Javadoc
-rw-r--r--plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentHelper.java3
-rw-r--r--plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentWithID.java16
2 files changed, 16 insertions, 3 deletions
diff --git a/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentHelper.java b/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentHelper.java
index 7cc8962..0ed697d 100644
--- a/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentHelper.java
+++ b/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentHelper.java
@@ -18,6 +18,9 @@ import java.net.URL;
import org.eclipse.emf.mwe.core.resources.ResourceLoaderFactory;
+/**
+ * Helper class that provides some utility methods for workflow components.
+ */
public class WorkflowComponentHelper {
/**
diff --git a/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentWithID.java b/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentWithID.java
index 6fe9bc1..c99e64d 100644
--- a/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentWithID.java
+++ b/plugins/org.eclipse.emf.mwe.core/src/org/eclipse/emf/mwe/core/WorkflowComponentWithID.java
@@ -12,15 +12,25 @@
package org.eclipse.emf.mwe.core;
/**
- * This is a workflow component that has an ID, so that it can be output in the
+ * This is a workflow component that has an Id, so that it can be output in the
* logger.
*/
public interface WorkflowComponentWithID extends WorkflowComponent {
+ /**
+ * Sets the Id of the component.
+ * @param id Component Id.
+ */
public void setId(String id);
+ /**
+ * Retrieves the Id of the component.
+ * @return Component Id.
+ */
public String getId();
-
- public String getLogMessage();
+ /**
+ * Retrieves a log message that can be reported to the execution log.
+ */
+ public String getLogMessage();
}