Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incomplete JavaDoc #32

Open
egonw opened this issue Dec 17, 2023 · 0 comments
Open

Incomplete JavaDoc #32

egonw opened this issue Dec 17, 2023 · 0 comments

Comments

@egonw
Copy link
Contributor

egonw commented Dec 17, 2023

[WARNING] Javadoc Warnings
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:129: warning: no description for @param
[WARNING] * @param f
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:142: warning: no description for @param
[WARNING] * @param f
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:144: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:188: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Real2.java:117: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Real2.java:301: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:91: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:40: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:69: warning: no description for @param
[WARNING] * @param r
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:70: warning: no description for @param
[WARNING] * @param th
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:49: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:50: warning: no description for @param
[WARNING] * @param b
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:81: warning: no description for @param
[WARNING] * @param p
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Complex.java:59: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/DoubleTool.java:33: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/DoubleTool.java:34: warning: no description for @param
[WARNING] * @param b
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidException.java:38: warning: no description for @param
[WARNING] * @param s
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidRuntimeException.java:65: warning: no description for @param
[WARNING] * @param exception
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidRuntimeException.java:56: warning: no description for @param
[WARNING] * @param msg
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidRuntimeException.java:37: warning: no description for @param
[WARNING] * @param message
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidRuntimeException.java:38: warning: no description for @param
[WARNING] * @param cause
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:162: warning: no description for @param
[WARNING] * @param test
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:163: warning: no description for @param
[WARNING] * @param expected
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:164: warning: no description for @param
[WARNING] * @param epsilon
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:166: warning: no @return
[WARNING] public static String testEquals(String msg, Plane3 expected, Plane3 test,
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:187: warning: no description for @param
[WARNING] * @param expected
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:188: warning: no description for @param
[WARNING] * @param epsilon
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/EuclidTestUtils.java:190: warning: no @return
[WARNING] public static String testEquals(String msg, double[] expected, Plane3 test,
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:32: warning: no description for @param
[WARNING] * @param nelem
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:33: warning: no description for @param
[WARNING] * @param arr
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:43: warning: no description for @param
[WARNING] * @param nelem
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:44: warning: no description for @param
[WARNING] * @param arr
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:45: warning: no description for @param
[WARNING] * @param f
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:55: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:89: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:90: warning: no description for @param
[WARNING] * @param b
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:114: warning: no description for @param
[WARNING] * @param a
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int.java:115: warning: no description for @param
[WARNING] * @param b
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:61: warning: no description for @param
[WARNING] * @param xy2
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:111: warning: no description for @param
[WARNING] * @param xx
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:119: warning: no description for @param
[WARNING] * @param yy
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:127: warning: no description for @param
[WARNING] * @param r
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:136: warning: no description for @param
[WARNING] * @param r2
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:145: warning: no description for @param
[WARNING] * @param r2
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:161: warning: no description for @param
[WARNING] * @param f
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:186: warning: no description for @param
[WARNING] * @param elem
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:188: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:201: warning: no description for @param
[WARNING] * @param p
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:210: warning: no description for @param
[WARNING] * @param r
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:237: warning: no @return
[WARNING] public Int2 incrementX() {
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:246: warning: no @return
[WARNING] public Int2 decrementX() {
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:255: warning: no @return
[WARNING] public Int2 incrementY() {
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:264: warning: no @return
[WARNING] public Int2 decrementY() {
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:271: warning: no description for @param
[WARNING] * @param xy0
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:272: warning: no description for @param
[WARNING] * @param xy1
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:273: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:52: warning: no description for @param
[WARNING] * @param r
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:42: warning: no description for @param
[WARNING] * @param x
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2.java:43: warning: no description for @param
[WARNING] * @param y
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:146: warning: no description for @param
[WARNING] * @param r2
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:178: warning: no description for @param
[WARNING] * @param leftSide
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:179: warning: no description for @param
[WARNING] * @param rightSide
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:181: warning: no @return
[WARNING] public Int2Range  getInt2RangeExtendedInX(int leftSide, int rightSide) {
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:192: warning: no description for @param
[WARNING] * @param topExtend
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:193: warning: no description for @param
[WARNING] * @param bottomExtend
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:195: warning: no @return
[WARNING] public Int2Range getInt2RangeExtendedInY(int topExtend, int bottomExtend) {
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:206: warning: no description for @param
[WARNING] * @param p
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:218: warning: no description for @param
[WARNING] * @param r
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:232: warning: no description for @param
[WARNING] * @param p
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:254: warning: no description for @param
[WARNING] * @param bbox
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/Int2Range.java:255: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntArray.java:344: warning: no description for @param
[WARNING] * @param m
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntArray.java:1295: warning: no description for @param
[WARNING] * @param s
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntArray.java:1296: warning: no description for @param
[WARNING] * @param delimiterRegex
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntArray.java:1312: warning: no description for @param
[WARNING] * @param delta
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntArray.java:1313: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:169: warning: no description for @param
[WARNING] * @param intListList
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:170: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:318: warning: no description for @param
[WARNING] * @param m
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:385: warning: no description for @param
[WARNING] * @param m2
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:416: warning: no description for @param
[WARNING] * @param m
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:507: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:564: warning: no description for @param
[WARNING] * @param row
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:565: warning: no description for @param
[WARNING] * @param col
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:601: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:609: warning: no description for @param
[WARNING] * @param row
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:610: warning: no description for @param
[WARNING] * @param col
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:611: warning: no description for @param
[WARNING] * @param f
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:612: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:659: warning: no description for @param
[WARNING] * @param jcol
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:660: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:735: warning: no description for @param
[WARNING] * @param irow
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:737: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:771: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:800: warning: no description for @param
[WARNING] * @param jcol
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:815: warning: no description for @param
[WARNING] * @param irow
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:853: warning: no description for @throws
[WARNING] * @throws EuclidRuntimeException
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:886: warning: no description for @param
[WARNING] * @param f
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:959: warning: no description for @param
[WARNING] * @param row
[WARNING] ^
[WARNING] /home/egonw/var/Projects/hub/blueobelisk/euclid/src/main/java/org/xmlcml/euclid/IntMatrix.java:994: warning: no description for @param
[WARNING] * @param column
[WARNING] ^
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant