search

punkave / grunt-dox

Grunt Plugin for generating Dox
MIT License
40 stars 13 forks source link

Just getting a doc file with only the title and can't figure out why #14

Closed jewelsjacobs closed 5 years ago

jewelsjacobs commented 11 years ago

I submitted this issue on stackoverflow in case I was supposed to.

When I try generating documentation with dox, all I get is an html file with the title. No errors on installing or running dox via grunt.

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

Here's some related files for reference:

Am I doing something wrong? BTW I'm running grunt test which has the dox task in it.

jewelsjacobs commented 11 years ago

Just an FYI I decided to forgo using this and went with node-jsdoc-toolkit, a shell script and grunt-shell.

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

Hope this helps someone!

mattmcmanus commented 11 years ago

Hey @jewelsjacobs, It seems like you moved on, but could you try running the straight up dox-foundation command w/ --raw?

The only reason this would happen is if the dox parser I'm using, dox, may not be returning anything. After a cursory glance, you jsdoc is using a lot of stuff I've never seen/used before so it may just be a use case I missed.

jarbot commented 11 years ago

I ran into a similar issue but some of my files are being documented and some aren't. In particular none of my backbone.js views show up in the file list. Models, collections, etc do (even when they don't have jsdoc comments). Are files ignored if they don't have jsdoc comments?

mattmcmanus commented 11 years ago

Hey @jarbot, Could you do me a favor and try and run the dox-foundation command on it's own and not through grunt-dox? This module is just a wrapper around that tool. If you get the same output then would you mind creating a ticket in that repo?

By default, dox-foundation ignores the directories: test, public, static, views and templates. It's easy to override that list with the --ignore flag.

jarbot commented 11 years ago

Thanks for your response @mattmcmanus, but my team has decided to use docker for the time being.

mattmcmanus commented 11 years ago

Sorry @jarbot. Docker looks pretty sweet.

If you have a minute, I'd love some honest feedback about on ways I could improve! matt at mcmanus.io.