Community
Participate
Working Groups
In my code, I have simple methods like this: /** * Returns if the heat is turned on */ public boolean isHotTurnedOn() { } I have left out the return tag out of complete laziness AND because the method name and the comment completely cover what the return value is (notice that even the Java API docs sometimes leave out tags). The problem is that cannot turn off the warnings or erros for this without also losing errors like this one: /** * Does something * @param foo The foo value */ public void doSomething(String bar) { } where the parameter tag is the wrong name. It would be nice to be able to control the behavior more. This is especially important when working on a codebase with 6000 classes, 100 developers and short timelines where javadoc is regularly missed, or done quickly (like my first example above). Right now I work in a codebase with 36,000 javadoc errors, which aren't really errors, just tags that were left out.
You can iuse different compiler setting for different projects. This might lower the number of flaged errors/warnings. Javadoc error detection is done by JDT/Core. Moving...
Adding all platforms
We could introduce yet another option to allow missing tags in javadocs... but then it weakens the value of Javadoc validation greatly IMHO. Need to think about it... or have more requests for it...
Just wanted to add one more thing to this bug. This stems from a general dislike of Eclipse for very large software products. For example, if a project has 6000 classes and many developers, it is not only possible but an almost certainty that many people have not commented their code well. I do not feel the need to go and correct 30,000 JavaDoc problems just to appease the IDE I'm using. That is why I opened this bug. I feel that JavaDoc errors should have their own page personally. I'd like to be able to control every aspect of their errors. Missing tags, incorrect names, extra tags, new tags (i.e. I use @asserts for assertion JavaDoc), bad HTML or XHTML (even better), bad links/references, etc. Something else that would be really nice would be an option to control whether or not JavaDoc errors are displayed like compile errors. For example, I could turn all JavaDoc problems to the "error" setting, but uncheck the "display as compile errors" option. This would mean that not until I open a file are the errors added to the list of problems or displayed. Therefore, I could see the problems in the files I'm working in and not the files that the 100 other developers are working in.
Fixed. See bug 46854 for more details...
Verified for 3.0M6.
