使用Appledocs生成文档

Question

我为我的问题的简单性道歉,但我试图使用Appledocs生成文档(https://github.com/tomaz/appledoc#quick-install)

我不确定如何设置它.我这样做的方式是:

• 我克隆了github repo,然后在终端中使用安装脚本(我使用appledocs --help确认这个)安装appledocs .

但是,现在我如何实际使用这个,因为我在xcode中有我的项目:

• 如何生成文档文件
• 它在哪里生成？

Answer 1

我一直在做的是为我的项目添加一个可以生成文档的新目标.您可以转到项目构建阶段并单击"添加目标".在Other下选择Aggregate并为其指定一些名称(例如ProjectDocumentation).

仍然在构建阶段选项卡上转到"添加构建阶段"并单击"添加运行脚本".您现在可以粘贴以下内容并将其调整为您自己的设置:

/usr/local/bin/appledoc \
--project-name HereProjectName \
--project-company "HereProjectCompany" \
--company-id com.companyName \
--keep-undocumented-objects \
--keep-undocumented-members \
--search-undocumented-doc \
--exit-threshold 2 \
--ignore .m \
--output "AppleDoc" .

我使用ignore*.m因为我只在头文件中编写文档.我的*.m文件中的文档仅供我自己使用(因此也是私有的).构建此目标时,文档将作为XCode docset生成.可以通过alt-单击类名来访问它.查看AppleDoc网站以获取语法注释.

有关命令行选项的说明,请检查appledoc --help命令.