2

导航中Global缺少菜单，同时：

  • 文件global.html存在
  • 未使用模板时，该Global条目出现在正确的 TOC 中

是否有特殊设置可用于要求DocStrap Template将Global菜单添加到导航？

以下是我的设置：

Gruntfile.js

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',
        },
    }
},

jsdocconf.json

{
    "tags": {
        "allowUnknownTags" : true
    },
    "plugins"   : ["plugins/markdown"],
    "templates": {
        "cleverLinks"           : true,
        "monospaceLinks"        : true,
        "dateFormat"            : "ddd MMM Do YYYY",
        "outputSourceFiles"     : false,
        "outputSourcePath"      : false,
        "systemName"            : "Name",
        "footer"                : "",
        "copyright"             : "Copyright",
        "navType"               : "vertical",
        "theme"                 : "spacelab",
        "linenums"              : true,
        "collapseSymbols"       : false,
        "inverseNav"            : false,
        "highlightTutorialCode" : true
    },
    "markdown"  : {
        "parser"   : "gfm",
        "hardwrap" : false
    }
}
4

1 回答 1

1

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

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

编辑：我假设不赞成票意味着提问者确实有全局条目，例如至少一个@typedef。

于 2015-02-20T18:11:12.747 回答