search

jbt / docker

Documentation generator
http://jbt.github.com/docker
MIT License
233 stars 56 forks source link

CoffeScript files not parsed correctly #15

Closed Prevole closed 11 years ago

Prevole commented 11 years ago

Hello, I try to use docker on a coffeescript project and I am not able to make it working correctly.

I use this command:

docker my_file.coffee -n --extras fileSearch,goToLine -c friendly

The problem is that the ### comments (multiline or not) are not parsed correctly. The parsing show this kind of lines as a sort of Markdown and therefore I have a result where some comments like the following will be partially parsed. A part is correctly parsed and appears in the documentation and the rest appears as code (the jsdoc comments especially).

###
## My title that appears correctly

my text comment that appears in the documentation correctly

@param {Object} p1 My first parameter that not appears correctly
@param {Object} p2 My second parameter that not appears correctly
@return {Object} The function return that not appears correctly too
###

Am I doing something wrong in the docker usage ?

jbt commented 11 years ago

Ah I know what that is - I think I broke it for when the comments are indented. Got a fix coming up.

jbt commented 11 years ago

There we go, hopefully 0.2.2 should fix it. Can you have a go and let me know if that works? Cheers.

Prevole commented 11 years ago

Thank you very much for the fix. Now it is working.

Prevole commented 11 years ago

Not related to the issue but could be usefull: https://npmjs.org/package/grunt-docker

jbt commented 11 years ago

Ooh, very nice. I don't tend to use grunt that much myself but that looks pretty useful. I'll check it out!