Inline events and also list method events with the class

apidoc/conf.json

@@ -25,6 +25,7 @@
         "apidoc/plugins/typedefs",
         "apidoc/plugins/api",
         "apidoc/plugins/todo",
+        "apidoc/plugins/events",
         "apidoc/plugins/observable"
     ],
     "markdown": {

apidoc/plugins/events.js

@@ -0,0 +1,47 @@
+var events = {};
+var classes = {};
+
+exports.handlers = {
+
+  newDoclet: function(e) {
+    var doclet = e.doclet;
+    var cls;
+    if (doclet.kind == 'event') {
+      cls = doclet.longname.split('#')[0];
+      if (!(cls in events)) {
+        events[cls] = [];
+      }
+      events[cls].push(doclet.longname);
+    } else if (doclet.kind == 'class') {
+      classes[doclet.longname] = doclet;
+    }
+  },
+
+  parseComplete: function(e) {
+    var doclets = e.doclets;
+    var eventClass, doclet, i, ii, j, jj, event, fires;
+    for (i = 0, ii = doclets.length - 1; i < ii; ++i) {
+      doclet = doclets[i];
+      if (doclet.fires) {
+        if (doclet.kind == 'class') {
+          fires = [];
+          for (j = 0, jj = doclet.fires.length; j < jj; ++j) {
+            event = doclet.fires[j].replace('event:', '');
+            if (events[event]) {
+              fires.push.apply(fires, events[event]);            
+            }
+          }
+          doclet.fires = fires;
+        } else {
+          eventClass = classes[doclet.longname.split('#')[0]];
+          if (!(fires in eventClass)) {
+            eventClass.fires = [];
+          }
+          eventClass.fires.push.apply(eventClass.fires, doclet.fires);
+        }
+      }
+    }
+  }
+
+};
+

apidoc/template/tmpl/container.tmpl

@@ -1,27 +1,36 @@
 <?js
     var self = this;
+
     docs.forEach(function(doc, i) {
 
       var observables, fires;
       if (doc.kind == 'class') {
         observables = doc.observables || [];
         fires = doc.fires || [];
-        var parents = doc.augments;
-        if (parents) {
-          for (var i = parents.length - 1; i >= 0; --i) {
-            var parent = parents[i];
-            while (parent) {
-              parent = self.find({longname: parent})[0];
-              if (!parent) { break; }
-              if (parent.observables) {
-                observables = observables.concat(parent.observables);
-              }
-              if (parent.fires) {
-                fires = fires.concat(parent.fires);
-              }
-              parent = parent.augments;
+        var parents = [].concat(doc.augments);
+        var parent = parents.pop();
+        while (parent) {
+          parent = self.find({longname: parent})[0];
+          if (parent) {
+            if (parent.observables) {
+              parent.observables.forEach(function(o) {
+                if (observables.indexOf(o) == -1) {
+                  observables.push(o);
+                }
+              });
+            }
+            if (parent.fires) {
+              parent.fires.forEach(function(f) {
+                if (fires.indexOf(f) == -1) {
+                  fires.push(f);
+                }
+              });
+            }
+            if (parent.augments) {
+              parents.push.apply(parents, parent.augments);
             }
           }
+          parent = parents.pop();
         }
         observables.sort();
         observables.forEach(function(o) {
@@ -146,10 +155,10 @@
     <?js } ?>
 
     <?js if (fires && fires.length) { ?>
-    <h3 class="subsection-title">Fires</h3>
-    <ul><?js fires.forEach(function(f) { ?>
-        <?js= self.partial('fires.tmpl', self.linkto(f, f.split('event:')[1]) ) ?>
-    <?js }); ?></ul>
+        <h3 class="subsection-title">Fires</h3>
+        <ul><?js fires.forEach(function(f) { ?>
+            <?js= self.partial('fires.tmpl', f) ?>
+        <?js }); ?></ul>
     <?js } ?>
     
     <?js

apidoc/template/tmpl/fires.tmpl

@@ -1,4 +1,16 @@
-<?js var data = obj; ?>
+<?js
+    var data = obj;
+    var self = this;
+    var parts = data.split(/#?event:/);
+    var link = self.linkto(parts[0], parts[0]);
+?>
 <li>
-    <?js= data ?>
+    <code><?js= parts[1] ?></code>
+    <?js if (link !== parts[0]) { ?>(<?js= self.linkto(parts[0], parts[0]) ?>)<?js } ?>
+    <?js var eventCls = self.find({longname: data})[0];
+    if (eventCls && eventCls.description) { ?>
+      <?js= (eventCls.description) ?>
+    <?js } else { ?>
+      <p>
+    <?js } ?>
 </li>

apidoc/template/tmpl/method.tmpl

@@ -40,10 +40,10 @@ var self = this;
     
     <?js= this.partial('details.tmpl', data) ?>
     
-    <?js if (data.fires && fires.length) { ?>
+    <?js if (data.kind !== 'class' && data.fires && fires.length) { ?>
     <h5>Fires:</h5>
     <ul><?js fires.forEach(function(f) { ?>
-        <?js= self.partial('fires.tmpl', self.linkto(f.replace('event:', '')) ) ?>
+        <?js= self.partial('fires.tmpl', f) ?>
     <?js }); ?></ul>
     <?js } ?>