Menu

#5 JSDoc Filter improvements

0.9.1
closed
jhammen
None
5
2015-03-18
2015-02-23
jhammen
No

It would be nice to use the JSDoc examples for the examples project but they do not work with the current JSDoc Filter

example:

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
function Book(title, author) {
}

From the JSDoc documentation, @constructor is the same as @class:

http://usejsdoc.org/tags-class.html

So we should be able to parse this as type "Book", it probably means parsing the name from the code AST that follows the comment block.

Discussion

  • Michael Gärtner

    • assigned_to: Michael Gärtner
     

    Last edit: Michael Gärtner 2015-03-17
  • Michael Gärtner

    I updated the JSDocFilter now it should work.

    @jhammen Could you verify my changes.

     
  • Michael Gärtner

    • assigned_to: Michael Gärtner --> jhammen
     
  • jhammen

    jhammen - 2015-03-17

    will do!

     
  • jhammen

    jhammen - 2015-03-18
    • status: open --> closed
     
  • jhammen

    jhammen - 2015-03-18

    looks great - I'm going to make a 0.9.1 release based on these fixes

     

Log in to post a comment.