Question

I'm using the grunt-dox grunt plugin to generate docco documentation out of a JavaScript file that has JsDoc dockblocks.

When I run the grunt task all I get is an HTML file with just the title I specified. No errors installing grunt-dox or running the task.

I'm on Mac OS X 10.8.3 but I have a strong feeling thats not why its not working.

Here's some related files for reference:

Am I doing something wrong? Has anyone gotten this to work? BTW I'm running grunt test which has the dox task in it.

Help would be much appreciated as I've been stuck on this for two days and ready to give up.

UPDATE: I tried to just run dox --title POC public/javascripts/build/docs/docs.js > public/docs/index.html and it hangs forever.

Grrr.

Was it helpful?

Solution

I'm going to mark this as an answer even though I never found out why this wasn't working.

In case someone else has unsuccessfully gone down this path, I highly suggest taking a look at what I eventually had to do to get decent API documentation for my javascript / node.js app

Basically I went with node-jsdoc-toolkit, a shell script and grunt-shell.

Hope this helps someone!

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top