WIP: autogenerate docs from ts #14
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
egoist
force-pushed
the
master
branch
3 times, most recently
from
5478674
to
fb77e73
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried two ways of going about with jsdoc to markdown plugin and typedoc. Neither outputs the same structure as whats currently used.
Typedoc produces convoluted structure and ignores descriptions as they stand. It doesn't handle destructed parameters. In terns of its convoluted structure, I couldn't find a way to hide wares class, and it will put classes and rest of typings in the same file separately. It has nice links though.
jsdoc doesn't detect types so they have to be duplicated.
I also can't get the tests to work, perhaps because I'm trying to support jsdoc.