我正在使用grunt-dox grunt插件从具有JsDoc dockblock的JavaScript文件中生成docco文档。
当我运行grunt任务时,我得到的只是一个带有我指定的标题的HTML文件。安装grunt-dox或运行任务没有错误。
我用的是Mac OS X 10.8.3,但我有一种强烈的感觉,那不是它不能工作的原因。
这里有一些相关的文件供参考:
- Gruntfile.js
- 项目。json从属 由dox生成的
- index.html -请忽略带有额外空格的格式
- JavaScript文件,我试图记录
我做错了什么吗?有人成功了吗?顺便说一句,我正在运行grunt test
,其中有dox任务。
如果你能帮助我,我将非常感激,因为我已经在这个问题上困了两天,准备放弃了。
更新:我试图只是运行dox --title POC public/javascripts/build/docs/docs.js > public/docs/index.html
和它永远挂起。
叽阿。
我要把这个标记为一个答案,尽管我从来没有发现为什么这不起作用。
如果其他人没有成功地沿着这条路走下去,我强烈建议看看我最终必须做些什么来为我的javascript/node.js应用程序获得体面的API文档
基本上我使用了node-jsdoc-toolkit,一个shell脚本和grunt-shell。
希望这能帮助到一些人!