首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >JSDoc3 & DocStrap:导航中缺少全局菜单

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

Stack Overflow用户
提问于 2014-10-29 11:09:10
回答 1查看 1.1K关注 0票数 2

导航中缺少的Global菜单:

  • global.html文件存在
  • 当不使用模板时,Global条目出现在正确的TOC中。

是否有特殊的设置可以让DocStrap TemplateGlobal菜单添加到导航中?

以下是我的设置:

Gruntfile.js

代码语言:javascript
复制
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

代码语言:javascript
复制
{
    "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
    }
}
EN

回答 1

Stack Overflow用户

发布于 2015-02-20 18:11:12

您需要确保您的文档注释指定了全局级别上存在的内容。@ty胡枝子是一个很好的例子,它说明了一件事情最终是全球性的。下面是一个例子:

代码语言:javascript
复制
/**
 * One of the following:
 * <code>'css'</code>, <code>'hbs'</code>, <code>'img'</code>, <code>'js'</code>
 * @typedef {String} SupportedAssetType
 */

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

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/26628792

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档