Merge pull request #9681 from ahocevar/apidoc-fixed-and-improved

Remove duplicates from api docs and make navigation more usable

config/jsdoc/api/plugins/api.js

@@ -59,7 +59,9 @@ function includeAugments(doclet) {
           });
         }
         cls._hideConstructor = true;
-        delete cls.undocumented;
+        if (!cls.undocumented) {
+          cls._documented = true;
+        }
       }
     }
   }
@@ -150,6 +152,9 @@ exports.handlers = {
         // Remove all other undocumented symbols
         doclet.undocumented = true;
       }
+      if (doclet._documented) {
+        delete doclet.undocumented;
+      }
     }
   }
 

config/jsdoc/api/template/publish.js

@@ -222,6 +222,10 @@ function buildNav(members) {
           type: 'module',
           longname: v.longname,
           name: v.name,
+          classes: find({
+            kind: 'class',
+            memberof: v.longname
+          }),
           members: find({
             kind: 'member',
             memberof: v.longname
@@ -240,30 +244,6 @@ function buildNav(members) {
           })
         });
       }
-      if (v.kind == 'class') {
-        nav.push({
-          type: 'class',
-          longname: v.longname,
-          name: v.name,
-          members: find({
-            kind: 'member',
-            memberof: v.longname
-          }),
-          methods: find({
-            kind: 'function',
-            memberof: v.longname
-          }),
-          typedefs: find({
-            kind: 'typedef',
-            memberof: v.longname
-          }),
-          fires: v.fires,
-          events: find({
-            kind: 'event',
-            memberof: v.longname
-          })
-        });
-      }
     }
   });
   return nav;

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

@@ -22,6 +22,20 @@ function toShortName(name) {
             </span>
             <ul class="members itemMembers">
             <?js
+            if (item.classes.length) {
+            ?>
+            <span class="subtitle">Classes</span>
+            <?js
+                item.classes.forEach(function (v) {
+            ?>
+                <li data-name="<?js= v.longname ?>"><?js= self.linkto(v.longname, toShortName(v.name)) ?></li>
+            <?js
+                });
+            }
+            ?>
+            </ul>
+            <ul class="members itemMembers">
+            <?js
             if (item.members.length) {
             ?>
             <span class="subtitle">Members</span>