JSDoc3＆DocStrap：全局菜單中缺少導航

的Global菜單中缺少在導航的同時：JSDoc3＆DocStrap：全局菜單中缺少導航

時不使用模板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 
    } 
}

來源

2014-10-29 Younes

嘗試使用「cosmo」主題來查看這是否相關。 – krampstudio 2014-10-30 08:49:34

這沒有幫助。在導航中仍然缺少'Global'（我對此感到滿意，因爲'主題'應該只針對外觀和感覺而不是內容）。 – Younes 2014-10-30 09:41:55

你需要確保你的文檔註釋指定在全球範圍內存在的東西埃爾。 @typedef是一個最終成爲全球化的好例子。這裏有一個例子：

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

編輯：我假設downvote意味着提問者確實具有全球性條目，如至少一個@typedef。

來源

2015-02-20 18:11:12

有問題的JsDoc評論確實有'@ typedef'。這就是爲什麼當我沒有使用上面提到的問題時使用模板時，Global條目存在。 – Younes 2015-07-24 17:54:14

JSDoc3＆DocStrap：全局菜單中缺少導航

回答

相關問題