Question

我尝试使用apidocjs创建API文档，在编译用于在项目文件夹上使用apidoc.json创建apidoc的项目时遇到了问题。

代码在这里：

~$ apidoc -i ./ -o apidoc/

结果

warning: parser plugin 'param' not found.
error:   Error: Can not read: apidoc.json, please check the format (e.g. missing comma).

请有人帮我解决这个问题

与apidocjs.com相关的标签

Answer 1

如果您使用@apiVersion功能，

删除 apidoc目标文件夹为@Prasanth建议将销毁您的历史记录。你可以重建它的唯一方法是通过并检查每个版本，然后运行apidoc。所以，如果你想使用版本控制。这不是你的答案。

您可能遇到语法问题或其他一些配置问题。在我的情况下，因为更新我有一些函数记录在javadoc样式与@param ...这曾经被忽略但现在抛出警告。

Answer 2

~$  apidoc -i ./ -e apidoc/ -o apidoc/

当api文档生成时，它会生成带有@param的main.js文件。因为@param也会在下一次生成时被检查，你可以跳过那个输出目录，所有这些都很好。

Answer 3

问题对我来说也是固定的，这个错误来自生成的docs / main.js。通常我们应该只解析必要的文件，以生成这个apiDoc。

我在命令中使用了-f .php，比如apidoc -f .php -i ./ -o ./。这就像一个奇迹。

Answer 4

我在使用erlang的钢筋中遇到了同样的问题，我所做的是在项目根文件夹中：

rm -rf doc/

然后我再次运行apidoc

info：Done