This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 186994 - [69cat] "Error in Javadoc" not always really an error
Summary: [69cat] "Error in Javadoc" not always really an error
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 6.x
Hardware: PC Windows XP
: P3 normal (vote)
Assignee: Jan Becicka
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-05-31 14:01 UTC by matthies
Modified: 2010-12-01 15:39 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description matthies 2010-05-31 14:01:32 UTC
The hint "Error in Javadoc" encompasses hints about missing @param tags and the like. Calling these "errors" is exaggerated and somewhat misleading, as the javadoc tool doesn't even warn about such cases. This should be differentiated more, IMO. For example I'd like to get a visual indication of stuff the javadoc tool will complain about, but for missing tags I at most want a current-line hint. Not sure if this hint does even check for stuff that the javadoc tool would complain about. It doesn't show anything for invalid {@link ...} tags for example. Anyway, the naming of the hint should take into consideration what the javadoc tools considers to be an error and what not.
Comment 1 Jan Becicka 2010-12-01 15:04:13 UTC
I'm not sure what you expect NB to do. Anyway it looks like enhancement.
Comment 2 matthies 2010-12-01 15:39:21 UTC
I'd expect "Error in Javadoc" to be restricted to erroneous syntax and stuff that the Javadoc tool considers to be an error or warning, such as dangling references. That would be really helpful for finding out about such errors without having to actually run the Javadoc tool.

A missing "@param" tag though is not an error, as it's (like all tags) optional in javadoc. I consider it a bug that "Error in Javadoc" marks this as an error. It's like if a hint "Error in Java source code" would complain about some coding style issue. If warnings/errors for missing @param tags are wanted, that ought to be a different hint (e.g. "Missing recommended Javadoc tag").