iOS - AppleDoc 使用

一: 安装

  // 下载代码
1: git clone git://github.com/tomaz/appledoc.git

  // 进入目录
2: cd ./appledoc

//执行安装脚本
3: sudo sh install-appledoc.sh

// 检验是否安装成功
4: appledoc --version

二 : 集成

 // 在项目目录下执行 [xxxx] 表示项目名， yyyy 表示公司名，注意后面的   [./]
 appledoc --project-name  xxxx --project-company yyyy ./
// 该步骤会在当前目录生成  docset-installed.txt

三 : Xcode 中 Target 部分

打开Xcode, 为该项目新建Target, 在Target中新建 Run Script 并加入如下内容

/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}/${docFilePath}"

四 : 文档内容

/**

@brief 订阅主题
@discussion 服务器查询主题，通过该方法订阅
@param topics 主题名
@param subscribeCallBack 订阅结果回调
*/
-(void)subscribeTopics:(NSDictionary *)topics subscribeCallBack:(void(^)(NSError *))subscribeCallBack

iOS - AppleDoc 使用

iOS - AppleDoc 使用

一: 安装

二 : 集成

三 : Xcode 中 Target 部分

打开Xcode, 为该项目新建Target, 在Target中新建 Run Script 并加入如下内容

四 : 文档内容

选中 Target 并运行, 可能会报 'docsetutil' not a developer tool or in PATH 不影响日志生成.

结果在 docset-installed.txt 中的PATH 路径. 是 docset 文件, 打开里面的 index 即可