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 36148 - implements interface editor suggestion should also add @inheritDoc Javadoc
Summary: implements interface editor suggestion should also add @inheritDoc Javadoc
Status: RESOLVED INVALID
Alias: None
Product: java
Classification: Unclassified
Component: Unsupported (show other bugs)
Version: 3.x
Hardware: All All
: P3 blocker (vote)
Assignee: issues@java
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-09-16 21:13 UTC by _ gtzabari
Modified: 2007-09-26 09:14 UTC (History)
1 user (show)

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 _ gtzabari 2003-09-16 21:13:57 UTC
Recently there has been a decision to remove a
bit of functionality from the "synchronize class"
feature. Previously if you implemented an
interface, the functionality would copy JavaDoc
comments from the interface you are implemented.
This was removed.

   I understand the original logic for removing
these comments but I believe we should at least
tack on the following JavaDoc when
auto-synchronizing a class:

  /**
   * {@inheritDoc}
   */

   If the user chooses to extend the method in a
manner that requires a JavaDoc change, he can do
so. If not, it is assumed he implements the
specification. I believe the original reason for
removing JavaDoc was if the super-interface
JavaDoc was modified, the implementor's JavaDoc
would no longer be correct. The above suggestion
should solve that problem.
Comment 1 Jan Chalupa 2004-11-21 22:59:02 UTC
Re-assigning to java.
Comment 2 Jan Becicka 2005-10-12 15:04:39 UTC
Synchronize feature was removed.
Comment 3 Rochelle Raccah 2005-10-12 22:26:40 UTC
Yes, but now there is a suggestion on typing "implements interface" that
implements all the methods in the interface, and there the @inheritDoc Javadoc
is also missing.  I've updated the summary for this.
Comment 4 _ gtzabari 2005-10-15 09:43:52 UTC
I suspect this issue should be closed as INVALID because my original
understanding of Javadoc was incorrect. When I had originally filed this issue I
was not aware that if an overriding method has no Javadoc defined, it
*automatically* inherits the Javadoc of the parent method. {@inheritDoc} is only
useful if you want to envelop the super-Javadoc with some surrounding comments
and I don't think this use-case intersects with the Netbeans use-case. That is,
when Netbeans creates stub-methods to be implemented, the Javadoc will be
inherited by default. If the user wishes to use @inheritDoc explicitly, they can
still do so.
Comment 5 Jan Becicka 2007-09-19 14:25:42 UTC
Invalid as suggested.