使用AppleDoc自动生成项目文档(XCode8)

AppleDoc 使用的时候如果项目中有pod第三方的会报错。无法生成 docset-installed.txt。

此时你可以 cd 到你项目的代码文件夹,去appledoc --project-name ******* --project-company ******* ./

结果会 Generation step 4/4 failed: GBDocSetInstallGenerator failed generating output, aborting!

并且生成 docset-installed.txt

这个是常规的appledoc的使用

引用:http://www.cocoachina.com/ios/20161125/18183.html


//下面这个会执行错误

1. appledoc --project-name 你的工程名字 --project-company 公司名 ./(导出路径,这里是指根目录)  path所要导出的文档的类文件夹

错误提示是:AppledocException: At least one directory or file name path is required

2. 正确的执行命令:

appledoc --no-create-docset --output ~/doc --project-name "Your Project Name" --company-id "com.yourcommpany" --project-company "Your Company"  ./

3. appledoc --project-name DiskSizeDemo

--project-company "ray"

--company-id aaaa

--output ./apple

~/DeskTop/RYDemoTest/DiskSizeDemo/DiskSizeDemo/doc/

最后一个命令需要5个参数:

1. 工程名字

2. 公司名字

3. 公司ID

4. 生成结果出书路径

5. 扫描那个路径下的类

执行成功都可以在我们相应的地址下找到

4. appledoc -o ./doc --project-name DiskSizeDemo --project-company feel .

appledoc会扫描当前路径下的所有文件,然后生成好文档放到doc目录下。你也可以用appledoc –help查看所有可用的参数。

使用的时候一定要注意最后一个路径,别忘了,不然会提示错误,最后一个是导出扫描到的文件


这个比较全,有详细出错的解决方案。注意 cd 到代码文件夹就可以生成 docset-installed.txt文件了

引用:http://blog.csdn.net/kangguang/article/details/70622770

你可能感兴趣的:(使用AppleDoc自动生成项目文档(XCode8))