provide example of events in AMD modules (jsdoc/jsdoc#412)

Author: hegemonic

Diff for: Jake/articles/tags-event

@@ -77,6 +77,62 @@ Hurl.prototype.snowball = function() {
  */
 {{/example}}
 
+<p>
+    The following example shows how to document events in the context of AMD modules.
+</p>
+
+{{#example}}Documenting events in AMD modules
+define('playground/monitor', [], function () {
+    /**
+     * Keeps an eye out for snowball-throwers.
+     * 
+     * @module playground/monitor
+     */
+    var exports = {
+        /**
+         * Report the throwing of a snowball.
+         * 
+         * @method
+         * @param {module:hurler#event:snowball} e - A snowball event.
+         * @listens module:hurler#snowball
+         */
+        reportThrowage: function (e) {
+            this.log('snowball thrown: velocity ' + e.velocity);
+        }
+    };
+
+    return exports;
+});
+
+define('hurler', [], function () {
+    /**
+     * Event reporting that a snowball has been hurled.
+     * 
+     * @event module:hurler#snowball
+     * @property {number} velocity - The snowball's velocity, in meters per second.
+     */
+
+    /**
+     * Snowball-hurling module.
+     * 
+     * @module hurler
+     */
+    var exports = {
+        /**
+         * Attack an innocent (or guilty) person with a snowball.
+         * 
+         * @method
+         * @fires module:hurler#snowball
+         */
+        attack: function () {
+            this.emit('snowball', { velocity: 10 });
+        }
+    };
+
+    return exports;
+});
+{{/example}}
+
 <h3>See Also</h3>
 
 <ul>

Diff for: tags-event.html

@@ -256,6 +256,66 @@ <h3>Examples</h3>
  * @property {boolean} isPacked - Indicates whether the snowball is tightly packed.
  */
 
+</pre>
+</dd>
+</dl><p>
+    The following example shows how to document events in the context of AMD modules.
+</p>
+
+<dl class="example">
+<dt>Documenting events in AMD modules</dt>
+<dd>
+<pre class="prettyprint lang-js">
+define('playground/monitor', [], function () {
+    /**
+     * Keeps an eye out for snowball-throwers.
+     * 
+     * @module playground/monitor
+     */
+    var exports = {
+        /**
+         * Report the throwing of a snowball.
+         * 
+         * @method
+         * @param {module:hurler#event:snowball} e - A snowball event.
+         * @listens module:hurler#snowball
+         */
+        reportThrowage: function (e) {
+            this.log('snowball thrown: velocity ' + e.velocity);
+        }
+    };
+
+    return exports;
+});
+
+define('hurler', [], function () {
+    /**
+     * Event reporting that a snowball has been hurled.
+     * 
+     * @event module:hurler#snowball
+     * @property {number} velocity - The snowball's velocity, in meters per second.
+     */
+
+    /**
+     * Snowball-hurling module.
+     * 
+     * @module hurler
+     */
+    var exports = {
+        /**
+         * Attack an innocent (or guilty) person with a snowball.
+         * 
+         * @method
+         * @fires module:hurler#snowball
+         */
+        attack: function () {
+            this.emit('snowball', { velocity: 10 });
+        }
+    };
+
+    return exports;
+});
+
 </pre>
 </dd>
 </dl><h3>See Also</h3>