使用appledoc生成第三方库的API

目前，很多第三方库都支持使用AppleDoc创建对应的API文档。你可以到第三方库的github页面去了解其是否支持appledoc以及相关的doc生成命令。

安装appledoc

//在terminal中输入
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh

//安装完成后，验证下是否成功
appledoc --version

生成文档

1. 先去github下载第三方库的源码。(git clone XXX.git)
2. cd到第三方库所在目录。
3. 在terminal中执行生成doc的命令。下面以AFNetworking为例(命令都可以对应的github页面上找到)

appledoc --project-name="AFNetworking" --project-company="AFNetworking" --company-id="com.afnetworking.afnetworking" AFNetworking/*.h

4. 然后就可以用dash查看文档了。

参考

用 appledoc 生成文档

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容