Appledoc 的安裝和基本使用浙值,可以參考此文章
這里記錄一個(gè)操作恳不,一般情況下。我們只需要某個(gè)目錄的class需要生成api文檔开呐。所以,針對(duì)xcode script的最后一行作如下改動(dòng):
#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會(huì)在~/Library/Developer/Shared/Documentation/DocSets目錄下面
這里記得要重新啟動(dòng)一下xcode才可以
附加
推薦使用工具dash進(jìn)行查看筐付,文檔更清晰一些。