问题标签 [rdoc]

是否有类似 javadoc 或 rdoc 用于记录 YAML 文件，以便我们可以将其提取到 HTML 文档中？理想情况下使用降价语法。

我刚刚安装了 RVM，并且正在阅读 The Well-Grounded Rubyist 的书。在第一章中，我应该尝试ri String#upcase查看有关 upcase 方法的文档，但是我收到一条消息：

对 String#upcase 一无所知

我在 SO 上发现了一些帖子，告诉我这可能是因为未安装 RDoc。但是我不明白如何解决它。

我正在使用 Mac OSX 10.6 和最新的 RVM。除了 Apple 开发工具包附带的标准 Ruby 解释器外，我只安装了 1.9.2。

我正在编写一个 Rails 3 插件，并且正在使用引擎。我的插件中有 app/ 文件夹，其中包含控制器、模型和视图。

问题是，当我想使用 RDoc 生成文档时，它不会进入 app/ 文件夹来解析其中的文件。有没有我必须传递给它的选项，以便它知道在哪里搜索它们？

I just installed rvm and then rails 3.1rc5 with:

But I got some errors after "Installing ri documentation" and the RDoc documentation:

The README file issues don't seem to be a big deal, but the 'lib' file not found sounds a bit scary.. why is it doing that? Some searching revealed others having this problem and fixing it with gem install rdoc and then re-running gem install rails --pre. But that still gives the same lib file missing errors for me.

我正在尝试在已升级到 Lion 的 Mac 上运行捆绑更新。

它始终无法获取 rdoc，并出现以下错误。

这可能是我可以解决的问题，还是 ruby​​gems 或 rdoc 的问题，我可以期望自己清楚地看到？

其他 gem 正在正确下载和安装。我没有直接在我的 Gemfile 中调用 rdoc，但我尝试使用特定（较低）版本添加它，但我得到了同样的错误。我也从gem install rdoc.

这是我的gemfile的内容：

如果我使用 Rails 3.1.0.rc1、rc2 或 rc3，一切正常。但他们似乎对链轮有问题（在此处引用）。建议使用 rails 3.1.0rc5。正是当我尝试这样做时（以​​及在 rc4 处），我才看到获取 rdoc 的问题。rails 3.1.0rc5 的替代方案是使用早期版本的 sprocket，但我也没有运气。

是否可以生成 LaTeX 格式的 RDoc？我查看了 RDoc 和 YARD，但没有找到我需要的东西。

我正在用 LaTeX 为我的 Ruby 项目编写文档，我需要一种方法来轻松地将 API 参考作为附录或章节嵌入到最终的 PDF 中。对我来说，最方便的是从 Ruby 源文件生成 LaTeX 源并在适当的地方包含它。

有没有办法在运行时显示 ruby​​ 核心和标准库文档gem server？

我可以浏览使用 rvm 创建的核心和标准文档，但我希望将所有文档放在一个地方。

我已经运行了rvm docs [generate|generate-ri|generate-rdoc]，但是这些命令都没有在 ruby​​gems 中添加文档。

windows下出现以下错误怎么办：

UPDATE2： 我使用的是 Mysql server 5.5，我在 /lib 目录中找到了 Libmql 文件，所以我将该文件粘贴到 ruby​​/bin 以及 ruby​​/lib 中。在 cmd 上我得到了同样的错误。

UPDATE1：再次运行这个，我得到：

C:\work\exchange2>gem install mysql 成功安装 mysql-2.8.1-x86-mingw32 1 gem installed 安装 mysql-2.8.1-x86-mingw32 的 ri 文档...

next_result 没有定义

field_name 没有定义

field_table 没有定义

field_def 没有定义

field_type 没有定义

field_length 没有定义

field_max_length 没有定义

field_flags 没有定义

field_decimals 没有定义

time_inspect 没有定义

time_to_s 没有定义

time_get_year 没有定义

time_get_month 没有定义

time_get_day 没有定义

time_get_hour 没有定义

time_get_minute 没有定义

time_get_second 没有定义

time_get_neg 没有定义

time_get_second_part 没有定义

time_set_year 没有定义

time_set_month 没有定义

time_set_day 没有定义

time_set_hour 没有定义

time_set_minute 没有定义

time_set_second 没有定义

time_set_neg 没有定义

time_set_second_part 没有定义

time_equal 没有定义

error_errno 没有定义

error_sqlstate 没有定义正在为 mysql-2.8.1-x86-mingw32 安装 RDoc 文档...

next_result 没有定义

field_name 没有定义

field_table 没有定义

field_def 没有定义

field_type 没有定义

field_length 没有定义

field_max_length 没有定义

field_flags 没有定义

field_decimals 没有定义

time_inspect 没有定义

time_to_s 没有定义

time_get_year 没有定义

time_get_month 没有定义

time_get_day 没有定义

time_get_hour 没有定义

time_get_minute 没有定义

time_get_second 没有定义

time_get_neg 没有定义

time_get_second_part 没有定义

time_set_year 没有定义

time_set_month 没有定义

time_set_day 没有定义

time_set_hour 没有定义

time_set_minute 没有定义

time_set_second 没有定义

time_set_neg 没有定义

time_set_second_part 没有定义

time_equal 没有定义

error_errno 没有定义

error_sqlstate 没有定义

我不确定这是否真的可行，但我试图通过在我们的app/models文件中添加范围的文档来使我们的 rails 应用程序的文档更加完整。我正在尝试做的是：

然后，当我在应用程序上运行 rdoc 时，我希望看到newest_records列为公共类方法以及更传统的方法，这些方法将被记录如下：

编辑

我意识到这个问题可能有点模棱两可。所以这里尝试澄清一下：目前，当我尝试在scope声明上方添加注释行时，我没有得到 RDoc 为范围生成的文档。我知道 RDoc 可以获取元方法/属性，否则它不会在用 . 声明的文档中显示属性attr_accessor。所以我的问题是如何向我的文件添加评论，以便：

• 该方法出现在我的 RDoc 生成的文档中
• 它显示为公共类方法（与公共实例方法等相反）

我想为我的 rails (2.3.8) 项目生成一个文档。当我尝试

它为所有类创建文档，包括标准 ruby​​ 类和供应商目录中的所有 ruby​​ 文件（插件等）

如何仅为 ruby​​ 类、以下目录中的文件创建 rdoc 文档

1. app 文件夹（所有模型、控制器和视图）
2. 配置文件夹
3. 库文件夹