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

Roadmap: Parse JSDocs comments to Markdown #2

Open
DaviSena opened this issue Jun 23, 2020 · 0 comments
Open

Roadmap: Parse JSDocs comments to Markdown #2

DaviSena opened this issue Jun 23, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@DaviSena
Copy link
Collaborator

Parse JSDocs comments to Markdown

type: Feature

Feature description

JSDocs is an API to generate documentation for JavaScript files, similar to Javadoc.
The API uses predefined tags and comments to document things like modules, namespaces, classes, methods, method parameters, and so on.

The idea of this improvement is to parse some of the JSDocs notations to the markdown that will be generated based on the JS source code.
@DaviSena DaviSena added the enhancement New feature or request label Jun 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@DaviSena