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

Document 'listens' tag #25

Closed
hegemonic opened this issue Apr 7, 2013 · 7 comments
Closed

Document 'listens' tag #25

hegemonic opened this issue Apr 7, 2013 · 7 comments
Milestone

Comments

@hegemonic
Copy link
Contributor

Just merged into master; available in JSDoc 3.2 and later.

@hegemonic
Copy link
Contributor Author

Need to move part of an example from the @event tag as part of this issue.

@octatone
Copy link

Is anyone actively working on this? I am actively consuming this tag, I'd be glad to start documenting it if this isn't progressing.

@hegemonic
Copy link
Contributor Author

There are a ton of very old, very small doc tasks laying around, including this one. I'm hoping to mop up all of these minor tasks within the next month or so.

I appreciate your offer to help, but in this case there's hardly anything to document. The tag syntax is @listens <eventName>. An example appears in the @event tag docs under "Documenting events in AMD modules."

@octatone
Copy link

Yeah, it's not listed in the index so it's really hard to stumble upon.

@hegemonic
Copy link
Contributor Author

I know, I know...

@dotnetchris
Copy link

If i was to submit a PR for this, would i just copy any file, say tags-function.html and make relevant edits to replace "function" usages with "listens" usages? Or is there some more elaborate scheme to this?

@hegemonic
Copy link
Contributor Author

You'll need to start with a Markdown file in content/en. Run gulp to generate updated HTML files.

@hegemonic hegemonic added this to the 3.2.0 milestone Dec 28, 2014
hegemonic added a commit that referenced this issue Jan 2, 2015
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

No branches or pull requests

3 participants