如何在jsdoc-grunt任务中使用jsdoc选项

时间:2016-06-29 10:38:26

标签: jsdoc3

我想添加-p标志,以便使用grunt-jsdoc生成私有方法的文档。我怎么能这样做?

根据grunt-jsdoc的文档,他们声明我们可以使用useJsDocCli中指定的任何选项,但是不知道应该如何在grunt任务中指定它们。这是我目前的咕噜声任务:

jsdoc : {
            dist : {
                src: ['app/scripts/directives/*.js','README.md'],
                options: {
                    destination: 'doc'
                }
            }
        }

如何指定我希望任务使用-p标志(或任何其他标志)运行?

1 个答案:

答案 0 :(得分:1)

模板部分https://github.com/krampstudio/grunt-jsdoc#templates

下的文档中有一个示例

只需使用没有短划线的标志名称,例如:

dist : {
    src: ['app/scripts/directives/*.js','README.md'],
        options: {
          destination: 'doc',
          private: true
        }
    }
}