While a good portion of methods is already enhanced by javadoc, a good portion is still missing.
It should be ensured that each package, class, attribute and method is fully documented, regardless of their code visibility, using javadoc. Complicated methods containing BLAS or LAPACK calls, magic numbers or handle special cases should be further described by inline comments.
Most – if not all – missing javadoc statements should be denoted as TODO within the source code since the commit 741c8d6be06f0f4f887a694ce34c1f524741abfe (Added TODOs for missing javadoc).
While a good portion of methods is already enhanced by javadoc, a good portion is still missing.
It should be ensured that each package, class, attribute and method is fully documented, regardless of their code visibility, using javadoc. Complicated methods containing BLAS or LAPACK calls, magic numbers or handle special cases should be further described by inline comments.
Most – if not all – missing javadoc statements should be denoted as TODO within the source code since the commit 741c8d6be06f0f4f887a694ce34c1f524741abfe (Added TODOs for missing javadoc).
Related issues:
65