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 252797 - Editor hints for JavaScript: Warning "undocumented parameter" with "@inheritdoc"
Summary: Editor hints for JavaScript: Warning "undocumented parameter" with "@inheritdoc"
Status: NEW
Alias: None
Product: javascript
Classification: Unclassified
Component: Editor (show other bugs)
Version: 8.0.2
Hardware: PC Linux
: P3 normal (vote)
Assignee: Petr Pisl
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-06-04 10:46 UTC by nagmat84
Modified: 2015-06-08 09:41 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description nagmat84 2015-06-04 10:46:16 UTC
If one overrides a method from a parent class in a child class and uses '@inheritdoc', the editor complains about "undocumented parameter" even if the parameter is documented for the parent method.

MWE

**
 * @summary The grandparent class
 * @class
 */
function ClassParent() {};

/**
 * @public
 * @summary Dumm didel di dumm
 * @param {string} bar Documentation of `bar`
 */
ClassParent.prototype.foo = function( bar ) {
  // do something with bar
};

ClassChild.prototype = Object.create( ClassParent.prototype );
ClassChild.prototype.constructor = ClassChild;

/**
 * @summary The child class
 * @class
 * @implements {ClassParent}
 */
function ClassChild() {};

/**
 * @inheritdoc
 */
ClassChild.prototype.foo = function( bar ) {
  // The editor complains about `bar` not being documented.
  // One can work around the warning by additionally add
  // a `@param` directive, but actually this already exist
  // in the parent class. Actually, the editor should
  // ignore missing `@param` directives if it encounters a
  // `@inheritdoc`
};
Comment 1 Petr Pisl 2015-06-08 09:41:44 UTC
The @inheritdoc tag is not supported yet.