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

Improve JSDOC plugin #3322

Closed
fifoosid opened this issue May 27, 2021 · 1 comment
Closed

Improve JSDOC plugin #3322

fifoosid opened this issue May 27, 2021 · 1 comment

Comments

@fifoosid
Copy link
Contributor

fifoosid commented May 27, 2021

Feature Request Description

We need:

  1. a way to hide inherited properties/methods from the docs
  2. a way to know if appendedDocs have @since tag

Proposed Solution

We need to:

  1. create a tag like @ignore for example, which will hide the docs for the given property/method.
  2. For the second issue, we can have two approaches:
    2.1. Read the @since tag of component whose docs are nested in order to show it
    2.2 Change our concept of showing the documentation of such components(Add separate pages, rather than appending it to the "mother" component)

Related info

  1. Related to
  1. Related to
@fifoosid fifoosid changed the title Improve JSDOC Improve JSDOC plugin May 27, 2021
@ilhan007 ilhan007 added this to the 1.0.0-rc.16 milestone Jun 1, 2021
@ilhan007 ilhan007 self-assigned this Sep 15, 2021
@ilhan007 ilhan007 removed this from the 1.0.0-rc.16 milestone Sep 20, 2021
@ilhan007 ilhan007 removed the Planned label Nov 17, 2021
@ilhan007 ilhan007 removed their assignment Nov 17, 2021
@ilhan007
Copy link
Member

Instead of improving the JS Doc plugin we will integrate TS Doc in future as we are migrating all the codebase to TS.
New issue will be created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Completed
Development

No branches or pull requests

3 participants