dox
dox copied to clipboard
JavaScript documentation generator for node using markdown and jsdoc
i have noticed that dox does not support `async function`s, examples: when used as a static function: ```ts /** * test1 */ Class.test = async function() { // test }...
I had a function with JSDoc, where I forgot to specify type of object for input parameter, like below `/** Some function @param {} timeout */` While generating a document,...
Would it be possible for you to bump the version number? I think the latest commit to bump deps is causing yarn install issues due to yarn not bein able...
The added test demonstrates an improper handling of escaped single quotes. Will see if I can get this fixed somehow. If the line is changed from ``` throw new Error('Something...
This commit adds a property "ctx.params" (an array of strings) to the parsed comment.. The rationale is that the @param-tags are not necessarily in the same order as the parameters...
I found that dox does a pretty good job on its own for handling ES-2015 and the modules syntax. However when trying to document my API, I found it impossible...
A few issues: ## 1 Ignore `-` symbol between type and description I have several `@param` tags. The output in my template is like this: ![screen shot 2016-05-15 at 9...
It's been a while, but I'll be coming back to dox! Question: does dox look at the comments when it can't infer from the code? Can we make it prioritize...
``` js $ cat