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

Support @inheritDoc and fix documentation for methods without jsdoc documentation #11

Open
cboulanger opened this issue Mar 9, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@cboulanger
Copy link
Contributor

cboulanger commented Mar 9, 2019

The ApiViewer should support the JsDoc @inheritDoc tag and use the documentation of the parent class (see http://usejsdoc.org/tags-inheritdoc.html) or (extending the jsdoc useage), its qx Interface class.

In addition, the current behavior needs to be fixed where methods without documentation will use the closes comment block even though there are empty lines before the method declaration:

Bildschirmfoto 2019-03-09 um 10 12 22

@johnspackman Is that technically possible with the AST? Or do we need to enforce at least a

/**
 * @inheritdoc
 */

before the method?

@hkollmann hkollmann added the enhancement New feature or request label Mar 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants