Xcode注释转文档appledoc使用

Posted xiu1004

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Xcode注释转文档appledoc使用相关的知识,希望对你有一定的参考价值。

参考了一些大神的方法总算成功了记录一下少走弯路

1:安装appledoc

使用终端下载:

命令行:

git clone git://github.com/tomaz/appledoc.git

cd ./appledoc

sudo sh install-appledoc.sh

查看是否安装成功:

命令行:

appledoc --version

appledoc version: 2.2.1 (build 1334)

 

 2   cd 进入工程目录 (目录下的所有文件都会被使用)

 

appledoc --no-create-docset --output ./doc --project-name 工程名 --project-company "公司名" --company-id "公司id" . //注意空格后加.

 

遇到的问题** Assertion failure in +[GBMethodData methodDataWithType:result:arguments:], /Users/../Desktop/911doc/appledoc/Model/GBMethodData.m:44

解决方法

打开appledoc工程GBMethodData.m
此处代码以及解决方法:

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

//重新执行安装脚本,强行走下去

cd ./appledoc

sudo sh install-appledoc.sh

然后重新编译





以上是关于Xcode注释转文档appledoc使用的主要内容,如果未能解决你的问题,请参考以下文章

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

IOS技术分享| iOS快速生成开发文档

AppleDoc

使用Xcode生成API文档---01简介

Xcode4快速Doxygen文档注释 — 简明图文教程

Xcode常用注释一览