scripting: bug 559043 Document using shared object
The fork javadoc now suggest a way to pass arguments containing comma or
more complex objects between scripts.
Change-Id: I96ed29e5ffbbb1d949079cec4fa5eac536fc323f
Signed-off-by: Geneviève Bastien <gbastien+lttng@versatic.net>
diff --git a/plugins/org.eclipse.ease.modules.platform/src/org/eclipse/ease/modules/platform/ScriptingModule.java b/plugins/org.eclipse.ease.modules.platform/src/org/eclipse/ease/modules/platform/ScriptingModule.java
index ec627eb..76a0290 100644
--- a/plugins/org.eclipse.ease.modules.platform/src/org/eclipse/ease/modules/platform/ScriptingModule.java
+++ b/plugins/org.eclipse.ease.modules.platform/src/org/eclipse/ease/modules/platform/ScriptingModule.java
@@ -117,7 +117,9 @@
* @param resource
* resource to execute (path, URI or file instance)
* @param arguments
- * optional script arguments delimited by commas ','
+ * optional script arguments delimited by commas ','. When the string arguments contains commas ',', or for arguments that are not string, the
+ * caller may set a shared object with {@module #setSharedObject(String, Object, boolean, boolean)} and pass the key here. The callee can then
+ * retrieve it with the {@module #getSharedObject(String)} method.
* @param engineID
* engine ID to be used
* @return execution result
