jbt / docker

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

@param parsing error (at least with CoffeeScript) #17

Closed Prevole closed 11 years ago

Prevole commented 11 years ago

Hi,

I am trying to write something like that:

@param {Function, String} template The template to register

The documentation generated gives that:

 String} Function template The template to register

If I write that (remove the comma after the Function):

@param {Function,String} template The template to register

I get this result:

 template Function String The template to register 

In my opinion, we should be able to write spaces inside the {} as they act as delimiters.

jbt commented 11 years ago

Yeah good shout, I'll update that.

adambiggs commented 11 years ago

@Prevole shouldn't the syntax be {Function|String}? Or does a comma mean something else in JSDoc?

jbt commented 11 years ago

Turns out I had support for using ,, | and / as separators (with or without surrounding spaces) but the logic around it was a bit broken. I think it should be fixed now.