问题标签 [jazzy]

我正在尝试安装 Jazzy Cocoapod，以便我可以使用它来记录我的 Swift 代码。我已经成功安装了 Cocoapods 0.35，但是 Jazzy 不会安装。我查找了应该生成但不存在的日志文件。这是错误消息：

$ sudo gem install jazzy 构建原生扩展。这可能需要一段时间... 错误：安装 jazzy 时出错：错误：无法构建 gem 原生扩展。

检查 C 编译器是否接受 ... 是 检查 C 编译器是否接受 -Wno-error=unused-command-line-argument-hard-error-in-future... 否 使用打包库构建 nokogiri。 * extconf.rb 失败 * 由于某种原因无法创建 Makefile，可能缺少必要的库和/或头文件。检查 mkmf.log 文件以获取更多详细信息。您可能需要配置选项。

提供的配置选项： --with-opt-dir --with-opt-include --without-opt-include=${opt-dir}/include --with-opt-lib --without-opt-lib=$ {opt-dir}/lib --with-make-prog --without-make-prog --srcdir=。--curdir --ruby=/Users/scott/.rvm/rubies/ruby-2.0.0-p0/bin/ruby --help --clean --use-system-libraries /Users/scott/.rvm/rubies /ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems/core_ext/kernel_require.rb:54:in require': cannot load such file -- openssl (LoadError) from /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems/core_ext/kernel_require.rb:54:inrequire'来自/Users/scott/.rvm/rubies/ruby-2.0.0-p0 /lib/ruby/2.0.0/net/https.rb:22:in<top (required)>' from /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems/core_ext/kernel_require.rb:54:in来自 /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems /core_ext/kernel_require.rb:54:in require' from /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/gems/2.0.0/gems/mini_portile-0.6.1/lib/mini_portile.rb:3:in'来自 /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems/core_ext/kernel_require.rb:128：在require' from /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems/core_ext/kernel_require.rb:128:in从 /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/site_ruby/2.0.0/rubygems/core_ext/kernel_require.rb:39:in 中require' from extconf.rb:395:in抢救

extconf 失败，退出代码 1

Gem 文件将继续安装在 /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/gems/2.0.0/gems/nokogiri-1.6.6.2 以供检查。结果记录到 /Users/scott/.rvm/rubies/ruby-2.0.0-p0/lib/ruby/gems/2.0.0/extensions/x86_64-darwin-12/2.0.0-static/nokogiri-1.6.6.2 /gem_make.out

任何人都可以帮我破译这个吗？谢谢你。

在对记录 swift 代码的最佳方法进行了一些研究之后。我遇到了 Jazzy，它的实现非常简单。所以我遵循Jazzy 文档的安装部分。我跑

然后我在终端中导航到我的项目的根目录，然后运行jazzy它创建一个名为“docs”的文件夹，其中包含一个显示 1 个类的文档的网站。我有 87 个类，我可以在终端输出中明显看到 jazzy 循环。

我已经阅读了有关文档化代码的NSHipster 教程，该教程还将您链接到Jazzy 文档以及标记格式参考。我已经记录了一些代码，Xcode 可以在侧窗格中正确显示或右键单击函数或类。所以我相当肯定我的语法是正确的。

我花了一些时间将该 1 个文件与另一个未显示的文件进行比较，并且在格式方面我没有看到任何异常。

我在跑：

• 爵士版：0.3.2
• Xcode 版本：7.1
• 斯威夫特版本：2.1
• OS X El Capitan 版本：10.11

我的总体问题是；为什么 jazzy 不为所有类生成文档，我该如何解决这个问题？

我想记录我的 swift 项目，我在 github 上找到了 jazzy。在查看指南后，我创建了一个新的简单项目并想尝试一下，这是我ViewController的一些文档信息：

这是我的命令：

我希望 html 有一些关于我的视图控制器的信息，但结果没有：

我想知道如何使用jazzy，希望得到一些建议。

我已经在我的项目中实现了 jazzy 拼写检查器，它正在工作，但我遇到了许多误报；拼写正确的单词显示为拼写错误。

我构建我的字典对象如下：

我四处寻找不同的词典，我收集到 jazzy 喜欢每行一个单词的格式。我尝试了 jazzy 下载附带的 eng_com.dic，并四处寻找其他一些。

字典中似乎还有一些所谓的拼写错误的单词……不确定问题出在哪里。

一些不应列为拼写错误的单词示例如下：

仅仅是找到一本好词典的问题吗？还是在最初创建对象后获取几个然后添加单词？

我也有一堆字典，其中的单词一起运行。我认为那些是 aspell 字典？（不久前下载了这个东西）那些不适用于爵士乐？

任何人以前遇到过这个问题并有一个很好的方法来处理它？

谢谢，bp

使用以下命令行，Jazzy 有以下问题。已经检查了命令行工具等，一切看起来都不错。

外壳命令/脚本

我想问一下Alamofire和Restofire的文档集为什么不同。

有什么办法可以让 Restofire 的文档像 Alamofire 一样。

当我看到下面的 Alamofire 文档时，它们是使用 jazzy 生成的。如何告诉可可豆荚使用 jazzy 生成评论。？

我正在用 Swift 编写一个 SKD，并且我有一个示例项目作为目标。目标用于测试 SDK 进行的网络调用。

我的项目结构看起来像这样

作为“开发”子文件夹的文件夹中的所有文件都被注释为 swift 文件，当单击选项时显示我希望导出的注释

我已经下载了 jazzy，但我看不到一种方法来指定路径扩展，因为它似乎可以构建项目并删除目标的注释。

但是我不希望这样，因为我的目标中的所有代码都不是我完成后要发送的内容。

我的问题是，有没有办法将文件夹扩展名（例如“/mac/project/target/development”）传递给 jazzy（或任何其他 gem 或程序），以便我可以为我的代码自动生成文档？或者在我全部输入之前，有没有人知道我可以使用的更好的解决方案或库！

我们正在尝试使用 Jazzy 和 Xcode7.3 为 Swift2.2 生成文档。我们有 2 个环境：本地开发环境（Macbook）和用于中央构建的服务器机器。

我们在 Xcode、命令行工具、Ruby 等两台机器上都有完全相同的设置，但在服务器 Jazzy 中失败并出现以下错误：

很多人建议使用，--swift-version 2.2但这对我不起作用.. :(

我们是否需要发送任何其他参数来消除此错误..？

我喜欢爵士乐，但我在 Objective C 过程中遇到了困难。许多类在 .m 文件中都有很好的记录，但在 .h 文件中却没有。如果我将 .m 文件名放在伞形标题中，jazzy 就会爆炸。除了将注释复制到 .h 文件之外，是否有一种较少手动密集型的方式来获得良好的结果？

只是想知道是否有人找到了解决此问题的方法。使用 --exclude 使用 swift 文件的完整文件路径，Jazzy 仍然在文档中包含这个文件/类。Shell 文件看起来像这样