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

Events shouldn't be listed under static members #486

Closed
kripod opened this issue Aug 3, 2016 · 2 comments
Closed

Events shouldn't be listed under static members #486

kripod opened this issue Aug 3, 2016 · 2 comments
Assignees
Labels

Comments

@kripod
Copy link
Contributor

kripod commented Aug 3, 2016

Using the following syntax:

/**
 * Connection event, fired when the client has connected successfully.
 * @event connect
 * @memberof Client
 */

The event Client#connect is listed under the static members in the generated documentation output. I think that events should have their own category in documentations, resulting in 3 categories for a class: "Events", "Static Members" and "Instance Members".

@kripod
Copy link
Contributor Author

kripod commented Aug 3, 2016

It turns out that adding an @instance tag under the @memberof tag solves the issue for HTML output. Events should be treated as instance methods by default. Anyway, please try to find a workaround for this and issue #96.

EDIT: While the @instance tag solves the issue for HTML output, it makes the event disappear from the generated markdown output.

@ProLoser
Copy link

I do @memberof Client# if I want to say it's a non-static member. This change just forces it to become an instance member and means I cannot make it a static member if I wanted, no?

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

No branches or pull requests

3 participants