我正在使用grunt-dox grunt plugin从包含docco个dockblocks的JavaScript文件生成JsDoc文档。
当我运行grunt任务时,我得到的只是一个HTML文件,只有我指定的标题。安装grunt-dox或运行任务时没有错误。
我使用的是Mac OS X 10.8.3,但我有一种强烈的感觉,这不是它无法正常工作的原因。
以下是一些相关文件供参考:
我做错了吗?有没有人得到这个工作?顺便说一下,我正在运行grunt test
,其中包含dox任务。
我非常感激帮助,因为我已经坚持了两天并准备放弃。
更新:我试图运行dox --title POC public/javascripts/build/docs/docs.js > public/docs/index.html
并且它会永远挂起。
哎呀。
答案 0 :(得分:0)
即使我从未发现为什么这不起作用,我也会将此标记为答案。
如果其他人未能成功走下这条道路,我强烈建议您查看what I eventually had to do to get decent API documentation for my javascript / node.js app
基本上我选择了node-jsdoc-toolkit,一个shell脚本和grunt-shell。
希望这有助于某人!