Commit activity
Last 12 weeks · 0 commits
Community health
1 of 6 standards met
28
✓README○License○Contributing○Code of Conduct○Issue Template○PR Template
Recent PRs & issues
Quiet · 2 in progress · Last activity 3y ago
See all on GitHub →
npm install -g dox ⠙ Fatal error in , line 0 Check failed: v8_flags.separate_gc_phases && young_gc_while_full_gc_ implies current_.state == Event::State::SWEEPING. #FailureMessage Object: 0xbeae7b98 Native stack trace -----
i have noticed that dox does not support s, examples: when used as a static function: it is recognized as a instead of : and when used as a normal function: it does not have a : the functions without async for comparison when used as a static function: is recognized as a properly: and when used as a normal function: it properly has a :
I had a function with JSDoc, where I forgot to specify type of object for input parameter, like below While generating a document, parser failed, but it didn't indicate where
Recent fixes
See attached test case.
This PR does: replace with scripts (not everyone might have and it is not nothing that could not be done in a script) remove gitmodules (because they seem to be installed via dev-dependencies now) add to to not duplicate lockfiles by accident update to be more consistent update to have consistent indent update examples in to current output and to be better readable outsource code examples to file for easier use with the binary add for consistent options across editors (like indent) add typescript types file for ease-of-use
This PR is still very much a work in progress. 1. Added fixture snapshots based on the codebase before the package was updated. I can remove them before taking the PR out of draft mode. 1. Updated the package and usage. 1. Removed an unsupported type test. Not sure about this change. I would still like to figure out why this type causes the parser to throw an error (below). I also updated the fixture snapshot to remove this pattern result. Error: 1. Updated some whitespace in the fixture snapshots. The tests currently fail, but I feel like I'm close to fixing the remaining issues.
Structured data for AI agents
Repository: tj/dox. Description: JavaScript documentation generator for node using markdown and jsdoc Stars: 2152, Forks: 195. Primary language: JavaScript. Languages: JavaScript (100%). Latest release: v1.0.0 (3y ago). Open PRs: 2, open issues: 17. Last activity: 3y ago. Community health: 28%. Top contributors: tj, Twipped, evindor, neogeek, hasezoey, A, gionkunz, trusktr, parasyte, vladtsf and others.