You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/** * 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".
The text was updated successfully, but these errors were encountered:
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.
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?
Using the following syntax:
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".The text was updated successfully, but these errors were encountered: