appledoc 使用方法

原创 2016年06月01日 17:17:33

第一步:克隆代码

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];
}

错误信息二:
这里写图片描述
return 2,调查没有找到对最后生成文档有什么影响。

备注:
appledoc不支持swift,不能显示swift中的注释信息等
appledoc只显示含有注释的property,method,如果该类没有注释信息,将不会生成该类对应的说明文档

亲自体验安装使用AppleDoc(iOS编写接口文档工具(网页版))及 appledoc/Model/GBMethodData.m:44报错处理

亲自体验安装使用AppleDoc(iOS编写接口文档工具(网页版)) 详细教程参见的另外一个博客:http://www.jianshu.com/p/ef5e2bae6894 补充:当你cd 把...
  • m0_38082632
  • m0_38082632
  • 2017年09月12日 16:45
  • 206

JavaScript中arguments对象的使用方法

arguments对象     arguments对象对应于传递给函数的参数,我们可以使用arguments对象在函数内部引用函数的参数。此对象中包含了传递给函数的每个参数的条目,与数组的方法类似,a...
  • crazyorange_shen
  • crazyorange_shen
  • 2017年04月01日 15:34
  • 213

iOS使用appledoc 生成技术API文档详解

转自:http://www.jianshu.com/p/65f1afdb9445 一、 首先安装 appledoc 第一步:使用终端命令进行下载安装 git clone git://...
  • Jason_chen13
  • Jason_chen13
  • 2017年06月05日 10:28
  • 452

Javascript中arguments对象的详解与使用方法

Javascript中arguments对象的详解与使用方法 投稿:daisy 字体:[增加 减小] 类型:转载 时间:2016-10-04 我要评论 ECMAScript中的函数并不介意...
  • hanyingzhong
  • hanyingzhong
  • 2017年01月04日 13:14
  • 184

用appledoc生成文档

由 ibireme 发表于 2013/08/26 Intro 接触过java的童鞋们一定知道javadoc这种东西,写好代码、码上注释,然后用javadoc一跑,一包html的文档就生...
  • mad2man
  • mad2man
  • 2014年04月26日 10:06
  • 3247

iOS appledoc自动生成API文档

iOS 自动生成API文档
  • L_weiguo
  • L_weiguo
  • 2017年06月07日 10:32
  • 337

浅谈arguments与arguments的妙用

1.每个函数都有一个arguments属性,表示函数的实参集合,这里的实参是重点,就是执行函数时实际传入的参数的集合。 2.arguments不是数组而是一个对象,但它和数组很相似,所以通常称为...
  • guofang9410
  • guofang9410
  • 2017年04月08日 18:10
  • 82

js中arguments的用法

1、在JavaScript中,arguments对象是比较特别的一个对象,实际上是当前函数的一个内置属性。arguments非常类似Array,但实际上又不是一个Array实例。可以通过如下代码得以证...
  • chenpeng19910926
  • chenpeng19910926
  • 2016年03月10日 15:40
  • 2684

AppleDoc 的使用

AppleDoc 的使用AppleDoc 的使用 AppleDoc 简介与安装 配置方式 进入程序目录 点击工程 Editor AddTarget Other Aggregate 如图 添加RunS...
  • fire_niao
  • fire_niao
  • 2016年08月02日 18:39
  • 106

JS中arguments对象详解

作者 : Windstep 出处: http://www.cnblogs.com/lwbqqyumidi/archive/2012/12/03/2799833.html1、在JavaS...
  • babybk
  • babybk
  • 2016年04月28日 11:28
  • 1765
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:appledoc 使用方法
举报原因:
原因补充:

(最多只允许输入30个字)