Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
JsDoc produces no documentation and no errors #46
If I run
I'm a bit perplexed. I have scrupulously documented nearly every public and private method in my codebase with jsdoc3 style comments.
Further, grunt-jsdoc does not seem to be recognizing the additional options I specify, such as for the markdown plugin and the verbose output.
Running the jsdoc command produces the same output. It sounds like I'll have to keep digging.
I did continue on to npm install jsdoc globally, so when I run jsdoc directly (as opposed to running from the grunt-jsdoc location ~node_modules\grunt-jsdoc\node_modules\jsdoc\jsdoc) with the --debug flag, I actually get the rhino debugger and can step through. It looks like the first problem is that jsdoc is looking for the 'plugins' folder at the root of my project (probably a red herring since it would normally look from the grunt-jsdoc relative path). Once removed, I can step through the entire execution without exception.
Further suggesting this is jsdoc's problem; but seems worth pointing out.
referenced this issue
Jul 6, 2013
The key appears to be using
After doing so in a single file, a few of my methods began appearing in the output. Then the remaining problems became much more obvious, most critically--when using
I think this is problem solved for me.