Closed RangerMauve closed 10 years ago
I hope you mean sth. like this :) Thanks for the issue!
Unfortunately there is a bug in the brackets registry so you can download from url or wait a bit.
Gonna test it out now, thanks for the quick reaction!
Some quick comments:
@return
, JSDoc uses @returns
, and that also has a type annotationOkay I will update it :) Have to find a bug in another project so wait a min pls.
Oh take your time, of course. This is in no way urgent.
Should work now :) You don't need to install from url brackets fixed the bug!
Awesome, but the type annotation still has curly braces around it in @param
definitions, as well in @returns
the annotation is on a newline instead of beside the label.
Example:
/**
example
@param token {String} some parameter, I guess
@returns {Promise} which resolves
*/
Results in
Returns:
Promise
which resolves to user's id
token {String}
user's session token
Do you prefer
Returns: type
description
Personally, I think it'd be fine with either style, as long as it's consistent between @returns
and @param
, though having the type on the same line as the label definitely looks cleaner in my opinion. Thanks again for the quick responses.
I updated it again 1.3.5!
That's perfect! Thanks again.
You're welcome thanks for the issue. It makes this extension better :)
From what I understand, JSDoc is the standard for documenting JavaScript and it might be better to support that instead of JavaDoc for parsing inline documentation.