JSDoc3& DocStrap:导航中缺少全局菜单

时间:2014-10-29 11:09:10

标签: jsdoc3

导航中缺少Global菜单:

  • global.html文件存在
  • 当没有使用模板时,{T <1}}条目出现在右侧TOC中

是否需要使用特殊设置才能要求GlobalDocStrap Template菜单添加到导航中?

以下是我的设置:

Gruntfile.js

Global

jsdocconf.json

jsdoc: {
    all: {
        src: [
            './src/main/js/**/*.js',
            './README.md',
        ],
        options: {
            destination: 'doc',
            tutorials: './src/main/js/tut',
            configure : "jsdocconf.json",
        template: 'node_modules/grunt-jsdoc/node_modules/ink-docstrap/template',
        },
    }
},

1 个答案:

答案 0 :(得分:1)

您需要确保您的文档注释指定了全局级别存在的内容。 @typedef是最终成为全局的事物的一个很好的例子。这是一个例子:

/**
 * One of the following:
 * <code>'css'</code>, <code>'hbs'</code>, <code>'img'</code>, <code>'js'</code>
 * @typedef {String} SupportedAssetType
 */

编辑:我假设downvote意味着提问者确实有全局条目,例如至少有一个@typedef。