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
The JSDoc documentation in this repo uses this format when @linking to code in its comments: {@link EventEmitterMixin#on}, where a # symbol separates the interface/class name and the interface/class's member:
* the optional `context` parameter on the {@link EventEmitterMixin#on} method to do so
JSDoc supports this syntax, although it is not well documented. Note the example of it under the "Example" heading here, but no formal documentation on how to reference class members.
It seems that using a . character instead of # is equally valid. TypeScript, VS Code, and other tools like TypeDoc that parse JSDoc comments recognize the . convention. However, TypeDoc does not recognize the # convention, which leads to broken links in documentation sites generated with TypeDoc.
We should switch to using the . format that's supported by the most tooling.
Additionally, the TS types in this project reference the EventEmitterMixin symbol when is should be referencing the IEventEmitter interface.
The text was updated successfully, but these errors were encountered:
yokuze
added a commit
to yokuze/event-emitter
that referenced
this issue
Nov 18, 2021
Additionally, use IEventEmitter in @links rather than EventEmitterMixin.
The documentation for IEventEmitter contained references to
EventEmitterMixin, but it should be referencing itself (IEventEmitter).
The JSDoc documentation in this repo uses this format when
@link
ing to code in its comments:{@link EventEmitterMixin#on}
, where a#
symbol separates the interface/class name and the interface/class's member:event-emitter/src/types/index.d.ts
Line 13 in 32e131f
JSDoc supports this syntax, although it is not well documented. Note the example of it under the "Example" heading here, but no formal documentation on how to reference class members.
It seems that using a
.
character instead of#
is equally valid. TypeScript, VS Code, and other tools like TypeDoc that parse JSDoc comments recognize the.
convention. However, TypeDoc does not recognize the#
convention, which leads to broken links in documentation sites generated with TypeDoc.We should switch to using the
.
format that's supported by the most tooling.Additionally, the TS types in this project reference the
EventEmitterMixin
symbol when is should be referencing theIEventEmitter
interface.The text was updated successfully, but these errors were encountered: