From 9345a331d508eb5a162d31c530718d044bfe1fc5 Mon Sep 17 00:00:00 2001
From: Don Brutzman <brutzman@nps.edu>
Date: Sun, 12 Apr 2020 10:36:11 -0700
Subject: [PATCH] javadoc
---
.../org/web3d/vrml/export/compressors/CompressionTools.java | 4 ++--
.../org/web3d/vrml/scripting/ecmascript/builtin/MFBool.java | 2 +-
.../org/web3d/vrml/scripting/ecmascript/builtin/MFColor.java | 4 ++--
.../web3d/vrml/scripting/ecmascript/builtin/MFColorRGBA.java | 4 ++--
.../org/web3d/vrml/scripting/ecmascript/builtin/MFDouble.java | 4 ++--
.../org/web3d/vrml/scripting/ecmascript/builtin/MFFloat.java | 4 ++--
.../org/web3d/vrml/scripting/ecmascript/builtin/MFImage.java | 4 ++--
.../org/web3d/vrml/scripting/ecmascript/builtin/MFInt32.java | 4 ++--
.../web3d/vrml/scripting/external/buffer/ExternalEvent.java | 2 +-
9 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/src/java/org/web3d/vrml/export/compressors/CompressionTools.java b/src/java/org/web3d/vrml/export/compressors/CompressionTools.java
index c73d2b1a..660ee8c3 100644
--- a/src/java/org/web3d/vrml/export/compressors/CompressionTools.java
+++ b/src/java/org/web3d/vrml/export/compressors/CompressionTools.java
@@ -904,8 +904,8 @@ System.out.println();
/**
*
* @param data
- * @param start
- * @param length
+ * @param start the start position in the array
+ * @param length number of values to read from the array
* @param useLen
* @return
* @throws IOException
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFBool.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFBool.java
index cba73bb8..cecb301c 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFBool.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFBool.java
@@ -141,7 +141,7 @@ public class MFBool extends FieldScriptableObject {
* @param args
* @param ctorObj
* @param inNewExpr
- * @return
+ * @return MFBool result
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColor.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColor.java
index 508bf928..f2b42bc4 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColor.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColor.java
@@ -136,7 +136,7 @@ public class MFColor extends FieldScriptableObject {
/**
* Constructor for a new Rhino object
- * @return
+ * @return MFColor result
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
@@ -153,7 +153,7 @@ public class MFColor extends FieldScriptableObject {
/**
* Check for the indexed property presence.
- * @return
+ * @return whether indexed property index is nonnegative (TODO check)
*/
@Override
public boolean has(int index, Scriptable start) {
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColorRGBA.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColorRGBA.java
index 78dc67fc..784ca6d0 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColorRGBA.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFColorRGBA.java
@@ -136,7 +136,7 @@ public class MFColorRGBA extends FieldScriptableObject {
/**
* Constructor for a new Rhino object
- * @return
+ * @return MFColorRGBA result
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
@@ -153,7 +153,7 @@ public class MFColorRGBA extends FieldScriptableObject {
/**
* Check for the indexed property presence.
- * @return
+ * @return whether indexed property index is nonnegative (TODO check)
*/
@Override
public boolean has(int index, Scriptable start) {
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFDouble.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFDouble.java
index 376bedb4..e5ffd411 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFDouble.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFDouble.java
@@ -138,7 +138,7 @@ public class MFDouble extends FieldScriptableObject {
/**
* Constructor for a new Rhino object
- * @return
+ * @return MFDouble result
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
@@ -155,7 +155,7 @@ public class MFDouble extends FieldScriptableObject {
/**
* Check for the indexed property presence.
- * @return
+ * @return whether indexed property index is nonnegative (TODO check)
*/
@Override
public boolean has(int index, Scriptable start) {
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFFloat.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFFloat.java
index 24445fc6..eb165e9f 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFFloat.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFFloat.java
@@ -120,7 +120,7 @@ public class MFFloat extends FieldScriptableObject {
/**
* Constructor for a new Rhino object
- * @return
+ * @return MFFloat result
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
@@ -137,7 +137,7 @@ public class MFFloat extends FieldScriptableObject {
/**
* Check for the indexed property presence.
- * @return
+ * @return whether indexed property index is nonnegative (TODO check)
*/
@Override
public boolean has(int index, Scriptable start) {
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFImage.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFImage.java
index 0ef02fc1..6d6fb783 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFImage.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFImage.java
@@ -137,7 +137,7 @@ System.out.println("MFImage int[] constructor not implemented yet");
/**
* Constructor for a new Rhino object
- * @return
+ * @return MFImage result
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
@@ -154,7 +154,7 @@ System.out.println("MFImage int[] constructor not implemented yet");
/**
* Check for the indexed property presence.
- * @return
+ * @return whether indexed property index is nonnegative (TODO check)
*/
@Override
public boolean has(int index, Scriptable start) {
diff --git a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFInt32.java b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFInt32.java
index f1117adb..0df97800 100644
--- a/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFInt32.java
+++ b/src/java/org/web3d/vrml/scripting/ecmascript/builtin/MFInt32.java
@@ -96,7 +96,7 @@ public class MFInt32 extends FieldScriptableObject {
*
* @param vals The array to source values from
* @param start The starting index in the array to work from
- * @param length
+ * @param length number of values to read from the array
*/
public MFInt32(int[] vals, int start, int length) {
this(); // invoke default constructor
@@ -143,7 +143,7 @@ public class MFInt32 extends FieldScriptableObject {
* Constructor for a new Rhino object
*
// * @param nodes The list of nodes to use
- * @return
+ * @return MFInt32 value
*/
public static Scriptable jsConstructor(Context cx, Object[] args,
Function ctorObj,
diff --git a/src/java/org/web3d/vrml/scripting/external/buffer/ExternalEvent.java b/src/java/org/web3d/vrml/scripting/external/buffer/ExternalEvent.java
index db0692a4..491a4e13 100644
--- a/src/java/org/web3d/vrml/scripting/external/buffer/ExternalEvent.java
+++ b/src/java/org/web3d/vrml/scripting/external/buffer/ExternalEvent.java
@@ -31,7 +31,7 @@ public interface ExternalEvent {
* Is the event conglomerating or non-conglomerating. Conglomerating events
* such as the set1Value calls build up in the event buffer.
*
- * @return
+ * @return whether event is conglomerating or not
*/
boolean isConglomerating();
}
--
GitLab