Jazzy不能按照预期生成快速文档
在做了一些关于文件swift代码的最佳方法的研究之后。 我遇到了Jazzy,实现起来多么简单。 所以我按照Jazzy文档的安装部分。 我跑
sudo gem install jazzy
然后,我浏览到我的项目的根,在terminal,并运行jazzy
,创build一个名为“docs”的文件夹与网站,显示1类的文件。 我有87个class,我可以看到在terminal输出爵士循环。
我已经阅读了关于logging代码的NSHipster教程,这些代码还将您链接到Jazzy文档以及标记格式参考 。 我已经logging了一些代码,Xcode在侧窗格中正确显示或者右键单击函数或类。 所以我相当肯定我的语法是正确的。
我花了一些时间来比较这1个文件到另一个没有被显示的文件,我没有看到格式方面的任何exception。
我在跑:
- 爵士版本:0.3.2
- Xcode版本:7.1
- Swift版本:2.1
- OS X El Capitan版本:10.11
我的总体问题是, 为什么不是所有类的爵士生产文档,我怎样才能解决这个问题?
在更深入地阅读爵士音乐之后,我发现了这个重要的信息。
默认情况下,爵士只会公开声明。 要为具有较低可访问级别(内部或私有)的声明生成文档,请将–min-acl标志设置为internal或private。
这是在爵士乐git枢纽页面的问题部分
我跑了爵士与下面的行来产生我期望的文档:
jazzy --min-acl private
注意我应该读一切之前,我决定有什么不正确的工作。
为了使它更好。 使用
jazzy --min-acl internal --skip-undocumented
说明:
--min-acl internal
这将包括纪录片中的所有function,类,结构
--skip-undocumented
这将忽略所有未logging的类…