summaryrefslogtreecommitdiff
path: root/scripting
diff options
context:
space:
mode:
authorNoel Grandin <noel@peralex.com>2012-08-20 12:54:24 +0100
committerCaolán McNamara <caolanm@redhat.com>2012-08-20 12:54:24 +0100
commitf6a62d9e4106f36aff899c847d63e3198532796e (patch)
tree2c006788af8c1367510d7cf2706fd1b8cdaa6b12 /scripting
parentaf4ca5a8c6e2848cb855a15986d5c4c9991140bf (diff)
Java update - fix various javadoc issues
Along the way, remove some javadoc comments that are completely incorrect. Change-Id: I02f96b6cbe665d2c10bd6ee245a7d8e2eef0f755
Diffstat (limited to 'scripting')
-rw-r--r--scripting/java/com/sun/star/script/framework/container/ParcelContainer.java11
-rw-r--r--scripting/java/com/sun/star/script/framework/provider/beanshell/ScriptEditorForBeanShell.java3
-rw-r--r--scripting/java/com/sun/star/script/framework/provider/java/ScriptProviderForJava.java4
-rw-r--r--scripting/java/com/sun/star/script/framework/provider/javascript/ScriptEditorForJavaScript.java3
-rw-r--r--scripting/java/com/sun/star/script/framework/provider/javascript/ScriptProviderForJavaScript.java2
5 files changed, 8 insertions, 15 deletions
diff --git a/scripting/java/com/sun/star/script/framework/container/ParcelContainer.java b/scripting/java/com/sun/star/script/framework/container/ParcelContainer.java
index ff4678f7a97f..367186ee44a2 100644
--- a/scripting/java/com/sun/star/script/framework/container/ParcelContainer.java
+++ b/scripting/java/com/sun/star/script/framework/container/ParcelContainer.java
@@ -217,11 +217,9 @@ public class ParcelContainer implements XNameAccess
* @param xCtx UNO component context
* @param containerUrl location of this container.
* @param language language for which entries are stored
- * @return name of <tt>ParcelContainer</tt>
- * @throws IllegalArgumentException
+ * @throws com.sun.star.lang.IllegalArgumentException
* @throws WrappedTargetException
*/
-
public ParcelContainer( XComponentContext xCtx, String containerUrl, String language ) throws com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException
{
@@ -235,8 +233,7 @@ public class ParcelContainer implements XNameAccess
* @param language language for which entries are stored
* @param loadParcels set to <tt>true</tt> if parcels are to be loaded
* on construction.
- * @return name of <tt>ParcelContainer</tt>
- * @throws IllegalArgumentException
+ * @throws com.sun.star.lang.IllegalArgumentException
* @throws WrappedTargetException
*/
public ParcelContainer( XComponentContext xCtx, String containerUrl, String language, boolean loadParcels ) throws com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException
@@ -252,10 +249,8 @@ public class ParcelContainer implements XNameAccess
* @param language language for which entries are stored
* @param loadParcels set to <tt>true</tt> if parcels are to be loaded
* on construction.
- * @return name of <tt>ParcelContainer</tt>
- * @throws IllegalArgumentException
+ * @throws com.sun.star.lang.IllegalArgumentException
*/
-
public ParcelContainer( ParcelContainer parent, XComponentContext xCtx, String containerUrl, String language, boolean loadParcels ) throws com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException
{
diff --git a/scripting/java/com/sun/star/script/framework/provider/beanshell/ScriptEditorForBeanShell.java b/scripting/java/com/sun/star/script/framework/provider/beanshell/ScriptEditorForBeanShell.java
index 1cfab1202b65..a679d695742b 100644
--- a/scripting/java/com/sun/star/script/framework/provider/beanshell/ScriptEditorForBeanShell.java
+++ b/scripting/java/com/sun/star/script/framework/provider/beanshell/ScriptEditorForBeanShell.java
@@ -184,9 +184,8 @@ public class ScriptEditorForBeanShell
* If an editor window is already open for that data it will be
* moved to the front.
*
- * @param metadata The metadata describing the script
* @param context The context in which to execute the script
- *
+ * @param entry The metadata describing the script
*/
public void edit(final XScriptContext context, ScriptMetaData entry) {
if (entry != null ) {
diff --git a/scripting/java/com/sun/star/script/framework/provider/java/ScriptProviderForJava.java b/scripting/java/com/sun/star/script/framework/provider/java/ScriptProviderForJava.java
index 4ed2f8e53fb6..c98a1ed59f95 100644
--- a/scripting/java/com/sun/star/script/framework/provider/java/ScriptProviderForJava.java
+++ b/scripting/java/com/sun/star/script/framework/provider/java/ScriptProviderForJava.java
@@ -165,7 +165,7 @@ class ScriptImpl implements XScript
* Invoke
*
*
- * @param aParams All parameters; pure, out params are undefined in
+ * @param params All parameters; pure, out params are undefined in
* sequence, i.e., the value has to be ignored by the callee
* @param aOutParamIndex Out indices
* @param aOutParam Out parameters
@@ -173,7 +173,7 @@ class ScriptImpl implements XScript
* @throws IllegalArgumentException If there is no matching script name
* @throws CannotConvertException If args do not match or cannot be converted
* the those of the invokee
- * @throws InvocationTargetException If the running script throws an exception
+ * @throws com.sun.star.reflection.InvocationTargetException If the running script throws an exception
* this information is captured and rethrown as this exception type.
*/
diff --git a/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptEditorForJavaScript.java b/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptEditorForJavaScript.java
index 3604677d0c24..d234a0019acf 100644
--- a/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptEditorForJavaScript.java
+++ b/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptEditorForJavaScript.java
@@ -167,9 +167,8 @@ public class ScriptEditorForJavaScript implements ScriptEditor
* If an editor window is already open for that data it will be
* moved to the front.
*
- * @param metadata The metadata describing the script
* @param context The context in which to execute the script
- *
+ * @param entry The metadata describing the script
*/
public void edit(final XScriptContext context, ScriptMetaData entry)
{
diff --git a/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptProviderForJavaScript.java b/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptProviderForJavaScript.java
index 9300e1ed450b..aa36af86a176 100644
--- a/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptProviderForJavaScript.java
+++ b/scripting/java/com/sun/star/script/framework/provider/javascript/ScriptProviderForJavaScript.java
@@ -149,7 +149,7 @@ class ScriptImpl implements XScript
*
*
*
- * @param aParams All parameters; pure, out params are
+ * @param params All parameters; pure, out params are
* undefined in sequence, i.e., the value
* has to be ignored by the callee
*