Document typedefs and enums used by API symbols

It is no longer necessary to add api annotations to typedefs and enums
that are used by API symbols.

config/jsdoc/api/plugins/api.js

@@ -11,6 +11,7 @@ exports.defineTags = function(dictionary) {
     canHaveType: false,
     canHaveName: false,
     onTagged: function(doclet, tag) {
+      includeTypes(doclet);
       var level = tag.text || "experimental";
       if (levels.indexOf(level) >= 0) {
         doclet.stability = level;
@@ -25,11 +26,15 @@ exports.defineTags = function(dictionary) {
 
 
 /*
- * Based on @stability annotations, and assuming that items with no @stability
+ * Based on @api annotations, and assuming that items with no @api annotation
- * annotation should not be documented, this plugin removes undocumented symbols
+ * should not be documented, this plugin removes undocumented symbols
  * from the documentation.
  */
 
+var api = [];
+var classes = {};
+var types = {};
+
 function hasApiMembers(doclet) {
   return doclet.longname.split('#')[0] == this.longname;
 }
@@ -71,8 +76,28 @@ function includeAugments(doclet) {
   }
 }
 
-var api = [];
+function extractTypes(item) {
-var classes = {};
+  item.type.names.forEach(function(type) {
+    types[type] = true;
+    //TODO handle Array.<type> etc.
+  });
+}
+
+function includeTypes(doclet) {
+  if (doclet.params && doclet.kind != 'class') {
+    doclet.params.forEach(extractTypes);
+  }
+  if (doclet.returns) {
+    doclet.returns.forEach(extractTypes);
+  }
+  if (doclet.isEnum) {
+    types[doclet.meta.code.name] = true;
+  }
+  if (doclet.type && doclet.meta.code.type == 'MemberExpression') {
+    // types in olx.js
+    extractTypes(doclet);
+  }
+}
 
 exports.handlers = {
 
@@ -120,7 +145,7 @@ exports.handlers = {
         // constructor from the docs.
         doclet._hideConstructor = true;
         includeAugments(doclet);
-      } else if (!doclet._hideConstructor) {
+      } else if (!doclet._hideConstructor && !(doclet.kind == 'typedef' && doclet.longname in types)) {
         // Remove all other undocumented symbols
         doclet.undocumented = true;
       }

config/jsdoc/api/template/tmpl/navigation.tmpl

@@ -39,7 +39,7 @@ var self = this;
             <?js
                 item.typedefs.forEach(function (v) {
             ?>
-                <li data-name="<?js= v.longname ?>" class="<?js= v.stability !== 'stable' ? 'unstable' : ''?>">
+                <li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability !== 'stable') ? 'unstable' : ''?>">
                     <?js= self.linkto(v.longname, v.name) ?>
                 </li>
             <?js
@@ -56,7 +56,7 @@ var self = this;
 
                 item.methods.forEach(function (v) {
             ?>
-                <li data-name="<?js= v.longname ?>" class="<?js= v.stability !== 'stable' ? 'unstable' : ''?>">
+                <li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability !== 'stable') ? 'unstable' : ''?>">
                     <?js= self.linkto(v.longname, v.name) ?>
                 </li>
             <?js
@@ -73,7 +73,7 @@ var self = this;
                 item.fires.forEach(function (v) {
                     v = self.find({longname: v})[0] || {longname: v, name: v.split(/#?event:/)[1]};
             ?>
-                <li data-name="<?js= v.longname ?>" class="<?js= (v.stability != 'stable' ? 'unstable' : '') ?>">
+                <li data-name="<?js= v.longname ?>" class="<?js= (v.stability && v.stability != 'stable') ? 'unstable' : '' ?>">
                     <?js= self.linkto(v.longname, v.name) ?>
                 </li>
             <?js

config/jsdoc/api/template/tmpl/observables.tmpl

@@ -21,7 +21,7 @@
         var setter = prop.readonly ? 'no' : 'yes';
   ?>
 
-    <tr class="<?js= prop.stability !== 'stable' ? 'unstable' : '' ?>">
+    <tr class="<?js= (prop.stability && prop.stability !== 'stable') ? 'unstable' : '' ?>">
       <td class="name"><code><?js= prop.name ?></code></td>
       <td class="type">
       <?js if (prop.type && prop.type.names) {?>

config/jsdoc/api/template/tmpl/stability.tmpl

@@ -2,6 +2,6 @@
 var data = obj;
 var self = this;
 
-if (data.stability != 'stable') { ?>
+if (data.stability && data.stability != 'stable') { ?>
 <span class="stability <?js= data.stability ?>"><?js= data.stability ?></span>
 <?js } ?>

config/jsdoc/api/template/tmpl/tutorial.tmpl

@@ -1,5 +1,5 @@
 <section>
-    
+
 <header>
     <?js if (children.length > 0) { ?>
     <ul><?js
@@ -10,10 +10,10 @@
     <?js } ?>
 
     <h2><?js= header ?></h2>
-</header>  
+</header>
 
 <article>
     <?js= content ?>
 </article>
 
-</section>  
+</section>