Wikunia / brackets-QuickDocsJS

Inline short documentation for JavaScript functions, including a summary,syntax and parameters.
70 stars 8 forks source link

Use JSDoc instead of JavaDoc #4

Closed RangerMauve closed 10 years ago

RangerMauve commented 10 years ago

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.

Wikunia commented 10 years ago

I hope you mean sth. like this :) Thanks for the issue!

Wikunia commented 10 years ago

Unfortunately there is a bug in the brackets registry so you can download from url or wait a bit.

RangerMauve commented 10 years ago

Gonna test it out now, thanks for the quick reaction!

RangerMauve commented 10 years ago

Some quick comments:

Wikunia commented 10 years ago

Okay I will update it :) Have to find a bug in another project so wait a min pls.

RangerMauve commented 10 years ago

Oh take your time, of course. This is in no way urgent.

Wikunia commented 10 years ago

Should work now :) You don't need to install from url brackets fixed the bug!

RangerMauve commented 10 years ago

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
Wikunia commented 10 years ago

Do you prefer

Returns: type
description
RangerMauve commented 10 years ago

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.

Wikunia commented 10 years ago

I updated it again 1.3.5!

RangerMauve commented 10 years ago

That's perfect! Thanks again.

Wikunia commented 10 years ago

You're welcome thanks for the issue. It makes this extension better :)