使用appledoc自动生成api文档

AppleDoc可以根据项目中的注释自动生成类似于Apple官方文档的文档文件.

安装 appledoc

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

如果出现 * INSTALL SUCCEEDED * 则说明我们安装成功了。

使用方法

进入工程主目录,执行

appledoc  --project-name "Your Project Name"  --company-id "com.yourcommpany"  --project-company "Your Company"  ./

这里省略了可以不添加的参数.如果有需要可以自己添加.
执行完成会在当前目录下生成一个docset-installed.txt的文件.这里是生成的docset存放地址.

集成到Xcode

新建一个target,类型为other中的Aggregate,将脚本添加到此target中,需要生成文档时,选择此target.平时build时不执行脚本.

也可以在当前的工程project下,打开build phrase,在Run Script下添加脚本.这样在bulid当前工程时就会执行脚本.

#appledoc Xcode script
# Start constants
company="abc";
companyID="com.abc";
companyURL="ht