gwtproject / gwt-typedarrays

Apache License 2.0
6 stars 10 forks source link

Javadoc warnings should be fixed #12

Open niloc132 opened 4 years ago

niloc132 commented 4 years ago

These don't prevent the build from running, and are also missing upstream, but should be fixed.

...
Generating /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/target/apidocs/allclasses-noframe.html...
Generating /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/target/apidocs/index.html...
Generating /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/target/apidocs/overview-summary.html...
Generating /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/target/apidocs/help-doc.html...
10 warnings
[WARNING] Javadoc Warnings
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/Int16Array.java:77: warning: no @param for offset
[WARNING] void set(Int16Array array, int offset);
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/client/JsUtils.java:52: warning: no description for @param
[WARNING] * @param str
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/client/JsUtils.java:267: warning: no description for @param
[WARNING] * @param buf
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/TypedArrays.java:39: warning: no description for @param
[WARNING] * @param byteLength
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/Uint16Array.java:77: warning: no @param for offset
[WARNING] void set(Uint16Array array, int offset);
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/Uint16Array.java:91: warning: no @param for offset
[WARNING] void set(int[] array, int offset);
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/Uint32Array.java:98: warning: no @param for offset
[WARNING] void set(Uint32Array array, int offset);
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/Uint32Array.java:116: warning: no @param for offset
[WARNING] default void set(long[] array, int offset) {
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/shared/Uint32Array.java:136: warning: no @param for offset
[WARNING] void set(double[] array, int offset);
[WARNING] ^
[WARNING] /home/colin/workspace/gwt-modules-rc1-release/gwt-typedarrays/gwt-typedarrays/src/main/java/org/gwtproject/typedarrays/client/Uint32ArrayNative.java:89: warning: no description for @param
[WARNING] * @param array
[WARNING] ^
...