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

Prevole opened this Issue Nov 15, 2012 · 3 comments


None yet
3 participants

Prevole commented Nov 15, 2012


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 Nov 15, 2012

Yeah good shout, I'll update that.

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

jbt closed this in 630b7d5 Dec 31, 2012


jbt commented Dec 31, 2012

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment