Task :javadoc: warning: no comment #1345
awatson1978
started this conversation in
General
Replies: 2 comments
-
Ah ha. Claude found the command that will suppress Xdoc Lint errors on startup:
|
Beta Was this translation helpful? Give feedback.
0 replies
-
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
When running the
./gradlew build check test
command, thejavadoc
tasks generates hundreds (thousands?) ofwarning: no comment
errors. Presumably, this is from overly strict linting rules.I went through and tried fixing some of the errors in the first file that listed
BB2RIFStructure.java
, and after a little bit of trial and error was able to figure out some of the syntax for writing comments. I've created a branch with an example of the file with comments that satisfy the compiler, but it's a lot of comments.So, the question is:
Should we, a) relax the linting rules so they don't ask for a comment for every enum entry, or b) continue ahead, and lay down comment blocks where needed, and proceed to get the documentation started?
Beta Was this translation helpful? Give feedback.
All reactions