JSDoc:如何向Nav Bar添加功能

时间:2016-07-07 16:12:22

标签: jsdoc jsdoc3

在jsdoc默认模板中,导航栏是在publish.js buildNav函数中构建的。

e.g。

nav += buildMemberNav(members.events, 'Events', seen, linkto);

然而,没有members.functions

我想知道如何列出导航栏中的所有功能(在每个命名空间,类下)。

1 个答案:

答案 0 :(得分:1)

我找到了一个模板https://github.com/nijikokun/minami/blob/master/publish.js#L298-L333,在那里他们为每个类创建了一个方法子列表作为参考。

说,如果我们要列出导航栏中每个命名空间下的所有函数,我们可以使用以下代码添加相关的html

var methods = find({kind:'function', memberof: item.longname}); 
在我们的案例中,

itemmember.namespace

if (methods.length) {
    itemsNav += "<ul class='methods'>";
    methods.forEach(function (method) {
        itemsNav += "<li data-type='method'>";
        itemsNav += linkto(method.longname, method.name);
        itemsNav += "</li>";
    });
    itemsNav += "</ul>";
}