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.
| Summary: | "Javadoc missing" for an overridden method | ||
|---|---|---|---|
| Product: | java | Reporter: | Tim Lebedkov <lebedkov> |
| Component: | Javadoc | Assignee: | Jan Becicka <jbecicka> |
| Status: | NEW --- | ||
| Severity: | blocker | CC: | DavidLeoni, Eusebius, fommil, markiewb |
| Priority: | P4 | ||
| Version: | 8.0.2 | ||
| Hardware: | All | ||
| OS: | All | ||
| Issue Type: | DEFECT | Exception Reporter: | |
Reassigning to java. I don't understand what is wrong, please clarify, thanks. it is not necessary to specify JavaDoc in an overridden methods. The JavaDoc from the parent class is automatically used. This is just a hint and I would expect as it works now. The ability of a subclass to override a method allows a class to inherit from a superclass whose behavior is "close enough" and then to modify behavior as needed. Modified behavior calls for modified javadoc. Maxi, what is your opinion? The present implementation checks sources whether the overridden method declares javadoc in class inheritance hierarchy. If none exists the hint occurs. But in case of the Servlet API library there are no attached sources for Servlet thus it always ends up with the missing javadoc hint. Checking for @Override or missing source file of the overridden method seems to be reasonable in this case. I will investigate not to hurt the performance. reassigning to javadoc *** Bug 178287 has been marked as a duplicate of this bug. *** *** Bug 212202 has been marked as a duplicate of this bug. *** This is still open as-of 8.0.1. Observation: while some organizations may want this to work as-is, others (like ours) find this behavior a nuisance; we want reminders of missing javadoc but our coding standards say that they are generally not needed for overrides unless there is a reason on a case-by-case. Because we generally like to see all of the yellow suggestions resolved this is an outlier for us. Suggestion: copy this to a second hint and have the new one ignore methods that are overridden. This should satisfy both camps of users. (Although there may be more people in the second camp.) Six years later, the situation is still the same in 8.0.2. Please consider adding an option to the "Create Javadoc" hint, allowing to ignore methods tagged with @Override. |
For the following method in my servlet I get a suggestion "Create missing JavaDoc" @Override public void init() throws ServletException {