关于Appledoc的实际运用

Appledoc 的安装和基本使用，可以参考此文章

这里记录一个操作，一般情况下。我们只需要某个目录的class需要生成api文档。所以，针对xcode script的最后一行作如下改动:

#appledoc Xcode script
# Start constants
company="abc";
companyID="com.abc";
companyURL="http://abc.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}/要搜索的目录" 

这样生成的doc就只有指定的目录了。
生成的doc会在~/Library/Developer/Shared/Documentation/DocSets目录下面
这里记得要重新启动一下xcode才可以

附加

推荐使用工具dash进行查看，文档更清晰一些。