appledoc 使用

1.安装

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

2.使用

进入代码所在目录,运行下面代码

appledoc --project-name MyProject --project-company ibireme ./

也可以在项目中运行脚本，把下面的相关属性改一下，即可

#appledoc Xcode script  
# Start constants  
company="ACME";  
companyID="com.ACME";
companyURL="http://ACME.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}"