You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
classA{/** * This method returns a number * @param {number} x * @return {number} */foo(x){returnx;}}classBextendsA{/** @inheritdoc */foo(x){returnx+1;}}
When building jsdoc directly, this works as intended, but when building using sphinx-js it results in the following failure:
sphinx_js.doclets.PathsTaken: Your JS code contains multiple documented objects at each of these paths:
./jspath.B#foo
We won't know which one you're talking about. Using JSDoc tags like @class might help you differentiate them.
Since this is a core jsdoc tag, it should be also supported by sphinx-js.
Issue is related to #110
The text was updated successfully, but these errors were encountered:
An annotation which includes the
@inheritdoc
tag should be ignored, with documentation derived from the parent class.https://jsdoc.app/tags-inheritdoc.html
Example
When building jsdoc directly, this works as intended, but when building using sphinx-js it results in the following failure:
Since this is a core jsdoc tag, it should be also supported by sphinx-js.
Issue is related to #110
The text was updated successfully, but these errors were encountered: