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

docgen: add support for classes and groups of things #15178

Closed
oandregal opened this issue Apr 25, 2019 · 5 comments
Closed

docgen: add support for classes and groups of things #15178

oandregal opened this issue Apr 25, 2019 · 5 comments
Labels
[Tool] Docgen /packages/docgen [Type] Enhancement A suggestion for improvement.

Comments

@oandregal
Copy link
Member

At the moment, classes aren't well documented. Only the JSDoc from the class declaration is taken into account, but we should also include method information, etc. Example: token-list.

A different example that could fall in the same category, could be groups of things: functions or literal objects that contain other functions. See api-fetch as an example.

@oandregal
Copy link
Member Author

oandregal commented Apr 25, 2019

One approach could be using the @class / @memberof / @constructor tags. Without the use of @memberof we can extract a lot of method info from classes, though.

@aduth
Copy link
Member

aduth commented Apr 25, 2019

functions or literal objects that contain other functions. See api-fetch as an example.

Another example I encountered in #15176 is the plugins object from @wordpress/data, which I explained in the pull request as desiring to better document but having unclear direction or support.

@oandregal
Copy link
Member Author

Related #14332

@oandregal
Copy link
Member Author

@jordesign jordesign added the [Type] Enhancement A suggestion for improvement. label Aug 4, 2023
@oandregal
Copy link
Member Author

I'm triagging issues we don't plan to tackle. We can reopen if it regains interest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Tool] Docgen /packages/docgen [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

3 participants