Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Also generate overrides #11

Closed
wants to merge 1 commit into from

Conversation

dcodeIO
Copy link

@dcodeIO dcodeIO commented Nov 16, 2016

This PR changes the way tsd-jsdoc checks for members already declared on the parent. Instead of searching for an already existing member with the same name on any parent, it now checks if the member is actually inherited, so that explicitly overridden members (i.e. a method that has a different signature) are generated.

This might affect other projects using tsd-jsdoc, depending on how overrides are documented there. If, for example, an @override annotation is present, then the member will still be skipped with the PR applied, but if it is not explicitly annotated as one, the member will now be generated. This is a bit counter-intuitive but it seems to be the jsdoc-way (it discards any jsdoc on the child when it sees @override, just like @inheritdoc does - see)

See: #9

@englercj
Copy link
Owner

As mentioned in #9, v2 supports this behavior but it is currently broken in jsdoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants