node.js - jsdoc3 のイベントタグの動作例

Question

@event タグを適切に使用する方法の例を教えてください。

ここで jsdoc3 のドキュメントを見てきました: http://usejsdoc.org/tags-event.html ですが、動作させることができませんでした。

私はnodejsを使用しています.MyClass/index.jsにMyClassという名前のコンストラクタをエクスポートするモジュールがあります:

module.exports = MyClass;
myClass = function () { ... };

そして私は追加しようとしました

/**
 * Snowball event.
 * @event MyClass#snowball
 */

コンパイルされたドキュメントでsnowballは、イベントのグローバル リストに表示されますが、クリックすると表示されます

The requested URL /{path-to-my-docs}/MyClass.html was not found on this server.

前もって感謝します。

Answer 1

これはうまくいきます：

/**
 * @class
 */
function Blah() {
}

/**
 * @event Blah#something
 * @type {Object}
 * @property {integer} some_field Represents something or other.
 */