iOS --appledoc的安装和使用

一、安装

　　1、github上下载地址:https://github.com/tomaz/appledoc.git

　　　2、下载之后，终端执行 cd /users/你的位置/desktop/appledoc 进入appledoc文件

　　　3、终端执行 sudo sh install-appledoc.sh 进入安装，安装成功会有success提示　 

二、使用

　　1、在工程里新建一个target，选择 Other 中的 Aggregate。

　　 

　　2、在新建的target里选择Build Phases,添加Run Script 

　　

　　3、将下面这段代码复制到 Run Script里即可，前五个参数改成你自己的。

　　

#appledoc Xcode script
# Start constants
company="abc";    //公司名
companyID="com.abc";    //公司id
companyURL="http://abc.com";   //公司url
target="iphoneos";     //操作系统
#target="macosx";
outputPath="~/desktop/xtmm/document";    //存放的位置
# 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}"

　　4、选择创建的这个target,build一下，然后完全退出再重新打开就可以生成文档了。

注意：build的时候会报错  Command /bin/sh failed with exit code 2，但是一样会生成文档，不知道是bug还是为什么....

 

转载于:https://www.cnblogs.com/zhangshan/p/5275520.html