Java

Java

Made by DeepSource
Malformed JavaDoc comment JAVA-D1007
Documentation
Major

This JavaDoc comment appears to be malformed. Such comments may raise errors or cause crashes when passed to a JavaDoc generation tool.

Rewrite the comment to use correct syntax.

JavaDoc tags should not be empty JAVA-D1006
Documentation
Major

Empty JavaDoc tags are meaningless, and may even cause tools that consume JavaDoc comments to crash.

Always add an explanation when writing JavaDoc tags.

Parameter tag has no description JAVA-D1005
Documentation
Major

This method/constructor has a parameter tag with no description.

Consider adding a description to the tag. If the parameter's name is clear enough, consider removing the parameter tag entirely.

Unmatched Parameter tag found JAVA-D1004
Documentation
Major

This method/constructor's parameter tags don't match its declared parameters.

This may confuse people who read the method's documentation. Remove/replace the misplaced tags so that each parameter has a matching JavaDoc description.

Undocumented class found JAVA-D1000
Documentation
Minor

This class does not have any documentation.

Consider adding a documentation comment to explain its use.

Undocumented constructor found JAVA-D1002
Documentation
Minor

This constructor does not have any documentation.

Consider adding a documentation comment to explain its use.

Undocumented declaration found JAVA-D1003
Documentation
Minor

This declaration is not documented.

Consider adding a documentation comment to explain its functionality.

Undocumented method found JAVA-D1001
Documentation
Minor

This method does not have any documentation.

Consider adding a documentation comment to explain its use.