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 把...

Objective-C 自动生成文档工具:appledoc 使用

将注释生成文档,在开发中会带来很大的便捷,好处自然你懂得,生成工具很多,appledoc 确实是最好用的,废话不多说,直接上手操作吧! 一、安装过程 第一步:下载安装 git clone git...

appledoc 在Mac OS 10.11安装问题

由于更换了电脑,今天之前mac电脑安装的电脑及插件都没了,今天试了在电脑上安装appledoc文档生成工具; 可能由于早起apple对mac的权限管理不太严,看之前的文档好像大家都可以根据文...

使用Objective-C的文档生成工具:appledoc

前言 做项目的人多了,就需要文档了。今天开始尝试写一些项目文档。但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手。象Java语言本身就自带javadoc命令,可以从源码中抽取文档。...

AppleDoc 的使用

AppleDoc 的使用AppleDoc 的使用 AppleDoc 简介与安装 配置方式 进入程序目录 点击工程 Editor AddTarget Other Aggregate 如图 添加RunS...

appledoc工具的使用

之前较忙,有一阵子没写博客了,闲来无事最近在看iOS开发进阶这本书,虽然接触iOS也有一年多了,但对一些工具还是了解的比较少,所以最近主要针对工具这块学习的,共勉; 看了下appledoc(https...

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

一、 首先安装 appledoc 第一步:使用终端命令进行下载安装 git clone git://github.com/tomaz/appledoc.git cd ./appledoc su...
  • donwei8
  • donwei8
  • 2016年04月11日 16:59
  • 575

555定时器的基本应用及使用方法

  • 2017年11月07日 15:20
  • 138KB
  • 下载

advgrid 使用方法

  • 2017年11月07日 15:21
  • 11KB
  • 下载

Jupyter Notebook各种使用方法记录

Python·Jupyter Notebook各种使用方法记录·持续更新标签(空格分隔): PythonPythonJupyter Notebook各种使用方法记录持续更新 一 Jupyter Not...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:appledoc 使用方法
举报原因:
原因补充:

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