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 96287 - Suggest {@inheritDoc} if method is implemented or extended
Summary: Suggest {@inheritDoc} if method is implemented or extended
Status: RESOLVED WONTFIX
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 6.x
Hardware: All All
: P3 blocker with 1 vote (vote)
Assignee: Jan Becicka
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-02-22 11:58 UTC by tomzi
Modified: 2013-08-30 11:53 UTC (History)
0 users

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description tomzi 2007-02-22 11:58:54 UTC 
If a method has been implemented or extended and you want to add javadoc to it
{@inheritDoc} should be suggested in 
. main descritption area
. @param, @return, @throws tags

see
http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#inheritingcomments
Comment 1 Peter Pis 2007-02-27 09:52:11 UTC 
Reassigning to "editor" for evaluation.
Comment 2 Vitezslav Stejskal 2007-02-27 20:36:52 UTC 
Honzo, is this something that would belong to your area of expertise? Shall we
reassign it?
Comment 3 Jan Pokorsky 2007-02-27 23:09:21 UTC 
Yes, it belongs to javadoc hints.

Not a bug IMO since javadoc is inherited (copied) by default and if you decide
to generate javadoc skeleton it is expected you fill it. It seems to me unhandy
to delete all {@inheritDoc}s in case you do not want to provide just a one
@param javadoc change.

Maybe we could provide one more hint Inherit Javadoc in case of inheritance that
would create {@inheritDoc} tags as you suggested.

Our goal is to offer the javadoc completion of block and in-line tags so it
would further simplify writing.
Comment 4 Ralph Ruijs 2013-08-30 11:53:09 UTC 
description and missing block tags are copied by default