From 4fe16d0281e938601e9347e33c98fa2cb0351491 Mon Sep 17 00:00:00 2001 From: Andreas Hocevar Date: Wed, 23 Oct 2019 13:26:47 +0200 Subject: [PATCH] Tidy up navigation --- config/jsdoc/api/template/publish.js | 50 ++++++++++--------- .../jsdoc/api/template/tmpl/navigation.tmpl | 5 ++ 2 files changed, 31 insertions(+), 24 deletions(-) diff --git a/config/jsdoc/api/template/publish.js b/config/jsdoc/api/template/publish.js index 45402fb006..4bc6c21445 100644 --- a/config/jsdoc/api/template/publish.js +++ b/config/jsdoc/api/template/publish.js @@ -222,9 +222,8 @@ function buildNav(members) { type: 'class', longname: v.longname, prettyname: v.longname - .substring(0, v.longname.indexOf('~')) - .replace('module:', '') - .replace('ol/', ''), + .split('~')[0] + .replace('module:', ''), name: v.name, module: find({ kind: 'module', @@ -253,33 +252,36 @@ function buildNav(members) { kind: 'class', memberof: v.longname }); - // only add modules without classes - if (classes.length === 0) { + const members = find({ + kind: 'member', + memberof: v.longname + }); + const methods = find({ + kind: 'function', + memberof: v.longname + }); + const typedefs = find({ + kind: 'typedef', + memberof: v.longname + }); + const events = find({ + kind: 'event', + memberof: v.longname + }); + // only add modules that have more to show than just a single class + if (classes.length !== 1 && (classes.length + members.length + methods.length + typedefs.length + events.length > 0)) { nav.push({ type: 'module', longname: v.longname, prettyname: v.longname - .substring(0, v.longname.indexOf('~')) - .replace('module:', '') - .replace('ol/', ''), + .split('~')[0] + .replace('module:', ''), name: v.name, - members: find({ - kind: 'member', - memberof: v.longname - }), - methods: find({ - kind: 'function', - memberof: v.longname - }), - typedefs: find({ - kind: 'typedef', - memberof: v.longname - }), + members: members, + methods: methods, + typedefs: typedefs, fires: v.fires, - events: find({ - kind: 'event', - memberof: v.longname - }) + events: events }); } } diff --git a/config/jsdoc/api/template/tmpl/navigation.tmpl b/config/jsdoc/api/template/tmpl/navigation.tmpl index 649f2cc2f3..bb1aac7d8b 100644 --- a/config/jsdoc/api/template/tmpl/navigation.tmpl +++ b/config/jsdoc/api/template/tmpl/navigation.tmpl @@ -14,6 +14,11 @@ function toShortName(name) { ?>
  • + + + + +