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: | [Synchronization] Interface synchronization of javadoc comments inconsistent | ||
---|---|---|---|
Product: | java | Reporter: | Steven Richman <srichman> |
Component: | Unsupported | Assignee: | issues@java <issues> |
Status: | CLOSED FIXED | ||
Severity: | enhancement | CC: | carcassi, jglick |
Priority: | P3 | ||
Version: | -S1S- | ||
Hardware: | PC | ||
OS: | Windows ME/2000 | ||
Issue Type: | DEFECT | Exception Reporter: |
Description
Steven Richman
2000-07-19 23:23:28 UTC
If the Synchronization code creates a new method in the class' code, it copies all its attributes, including JavaDoc comment contents. The same holds true for updating implementation according to an interface change; BUT JavaDoc comment does not trigger the synchronization mechanism -- implementation is still perfectly compilable. I don't think that synchronization of comments is desirable, because a comment of the interface method should explain purpose and usage of that method. Implementations should add their own peculiarities and comments (additional restrictions, links to related methods,...) instead of blindly copying interface's comment contents. The current behaviour (copy interface's JavaDoc into implementation) can be seen as a bug. If the implementation's comments are to be synchronized with the declaration comment, only JavaDoc tags related to the method's declaration should be updated (@return, @param, @throws); if the tag already exists, it should be updated iff the text is exactly the same as in the interface's source (to prevent user customizations from overwriting). I'll keep the request as an enhancement (for clarification and better specification of synchronization, at least). *** Bug 8200 has been marked as a duplicate of this bug. *** *** Bug 6135 has been marked as a duplicate of this bug. *** Reopening for 3.4 IMHO: Javadoc comments should *never* be synchronized automatically, and new impls should be given no comment. The Javadoc tool does a perfectly good job of collecting superclass info; synching the comments breaks this. Cleaning up before 4.0 planning Target milestone was changed from not determined to TBD Changing to defect. See issue 27886 Fixed (comment synchronization removed). See also issue #25429. VERIFIED BTW - cf. issue #30562. Resolved for 3.4.x or earlier, no new info since then -> closing. |