(iOS) AppleDoc生成代码文档

1. 安装AppleDoc

cd ~/Downloads/ && git clone git://github.com/tomaz/appledoc.git && cd ./appledoc && sudo sh install-appledoc.sh

可以通过 appledoc --help 查看相关命令

 

2.生成docset

appledoc --output ./docset --docset-install-path ./docset --project-name "AppleDoc" --project-company "xyz" --project-version "1.0.0" --no-warn-undocumented-object --no-warn-undocumented-member ./AppleDoc

#--output 输出目录;  --project-name 工程名;--project-version 版本号;--project-company 公司名;
#--no-warn-undocumented-member 没有属性和方法的文件不提示; ./AppleDoc 需要生成代码文档的目录

PS：生成的html就在 docset/x.docset/Contents/Resources/Documents 目录下

 

支付SDK命令记录如下：

appledoc --output ./docset --docset-install-path ./docset --project-name "HCCIPaymentSDK" --project-company “HC” --project-version "1.0.0" --no-warn-undocumented-object --no-warn-undocumented-member ./

 

注意事项：

1.集成了pod,引入某些三方库会导致appledoc编译出错，因此建议在集成三方库前生成docset

2.报错

*** Assertion failure in +[GBMethodData methodDataWithType:result:arguments:], /Users/zhaotong/Desktop/911doc/appledoc/Model/GBMethodData.m:44

Oops, something went wrong...

NSInternalInconsistencyException: Invalid parameter not satisfying: [arguments count] >= 1
解决方法：

找到GBMethodData.m:44 注释：

//NSParameterAssert([arguments count] >= 1);

重新安装：cd ./appledoc && sudo sh install-appledoc.sh