appledoc 使用方法

最新推荐文章于 2019-07-25 15:04:14 发布

酆狂鬣人

最新推荐文章于 2019-07-25 15:04:14 发布

阅读量1.1k

点赞数

文章标签： appledoc

本文链接：https://blog.csdn.net/u012016642/article/details/51557519

版权

本文档详细介绍了appledoc的安装步骤和使用方法，包括克隆代码、执行安装脚本、在项目中添加target来生成API文档。同时，针对遇到的错误信息如GBMethodData的断言失败和返回2的问题进行了分析，并指出appledoc不支持Swift以及未注释的属性和方法不会被记录的特性。

摘要由CSDN通过智能技术生成

第一步：克隆代码

git clone git://github.com/tomaz/appledoc.git   /指定目录

第二步：进入代码所在目录，执行安装脚本

sudo sh install-appledoc.sh

第三部：在项目中增加target用于生成说明文档

1⃣️在工程中 File－>New->Target->Other->aggregate
2⃣️New Run Script Phase
3⃣️脚本内容如下，酌情增删改

#appledoc Xcode script  
# Start constants  
company="ACME";  
companyID="com.ACME";
companyURL="http://ACME.com";
target="iphoneos";
#target="macosx";
outputPath="~/help";
# End constants
/usr/local/bin/appledoc \
--project-name "${PROJECT_NAME}" \
--project-company "${company}" \
--company-id "${companyID}" \
--docset-atom-filename "${company}.atom" \
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${companyURL}/${company}" \
--output "${outputPath}" \
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}"

最后：编译该target

自己工程遇到的执行错误

错误信息一： appledoc[13824:658676] * Assertion failure in +[GBMethodData methodDataWithType:result:arguments:], /Users/admin/Desktop/Git/appleDoc/Model/GBMethodData.m:44
此处代码以及解决方法：

+ (id)methodDataWithType:(GBMethodType)type result:(NSArray *)result arguments:(NSArray *)arguments {
    //NSParameterAssert([arguments count] >= 1); //注释掉断言，重新执行安装脚本，强行走下去
    return [[self alloc] initWithType:type attributes:[NSArray array] result:result arguments:arguments];
}