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.

Sign up for GitHub

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

Jump to bottom

[Feature] Annotate exported members with TypeDoc comments #211

Open
spiltcoffee opened this issue Feb 15, 2021 · 0 comments
Open

[Feature] Annotate exported members with TypeDoc comments #211

spiltcoffee opened this issue Feb 15, 2021 · 0 comments
Labels
feature New feature or request

Comments

@spiltcoffee
Copy link
Owner

What doesn't postdfm do that I would like it to?

Documentation is lacking. At the moment, TypeDoc built documentation just produces a nicer looking way to view the exported members.

TypeDoc does support annotating exported members with comments, see https://typedoc.org/guides/doccomments/ .

Am I willing to make a pull request with an implementation of the feature?

Yes
@spiltcoffee spiltcoffee added the feature New feature or request label Feb 15, 2021
@spiltcoffee spiltcoffee changed the title [Feature] Documentation [Feature] Annotate exported members with TypeDoc comments Feb 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@spiltcoffee