appledoc的使用

环境：xcode9

appledoc下载地址： https://github.com/tomaz/appledoc

一、安装appledoc

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

cd到appledoc的下载目录

sudo sh install-appledoc.sh

二、xode集成appledoc

新建tager，并新添加run script，并在run script里面添加如下内容：

#appledoc Xcode script

# Start constants

company="xzt";

companyID="com.xzt";

companyURL="http://xzt.com";

target="iphoneos";

#target="macosx";

outputPath="${SRCROOT}/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}"

3、选中这个tager，编译就会产生帮助文件，并添加到xcode的帮助目录下，集成到xcode工具里面

保存帮助文件的目录：

1、保存到自己指定的目录：

outputPath="${SRCROOT}/Document";  即： 会在项目下新创建一个Document目录，并把生成的文件保存到这个目录下

2、默认保存到xcode帮助文件目录下：  /User/lxt/Library/Developer/Shared/Documentation/