Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parse literal functions & properties (including @lends) #85

Closed
wants to merge 5 commits into from

Conversation

genehallman
Copy link

Implemented literal function and property parsing, including the @Lends tag.

Specifically useful for documenting literals, .extends and similar kinds of object construction techniques.

Tests included.

@tj
Copy link
Owner

tj commented Feb 27, 2013

what is @Lends ?

@genehallman
Copy link
Author

From http://code.google.com/p/jsdoc-toolkit/wiki/TagLends:

The @Lends tag allows you to document all the members of an anonymous object literal as if they were members of an object with the given name.

var TemplateView = Backbone.View.extend(
/* @lends TemplateView.prototype */
{
  /*
   * Draws stuff
   */ 
  render: function() {
    ...
  }
});

/*
 * Does stuff
 */
TemplateView.prototype.anotherMethod = function() {
...
};

I found this to be a useful way of documenting anonymous literals, particularly with .extends() style constructors.

Feel free to merge or not, or critique, we here at @Livefyre just needed the functionality and we thought we'd share it.

@shannonmoeller
Copy link

👍

1 similar comment
@jlnslv
Copy link

jlnslv commented Apr 11, 2013

+1

@shellscape
Copy link
Contributor

👍

@Twipped
Copy link
Collaborator

Twipped commented Mar 18, 2015

Closing this PR, since it has long since become un-mergable. @genehallman if this is still something you think dox needs, could you please create a new PR based on the current master?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants