class RDoc::RD

RDoc::RD 实现了来自 rdtool gem 的 RD 格式。

要选择 RD 作为你唯一的默认格式，请参阅 RDoc::Options 中的保存选项，以获取关于如何设置 .doc_options 文件来存储你的项目默认设置的说明。

许可证¶ ↑

生成 RDoc::RD::BlockParser 和 RDoc::RD::InlineParser 的语法包含在 RDoc 中，遵循 Ruby 许可证。

你可以在 github.com/uwabami/rdtool/ 找到 rdtool 的原始来源。

你可以根据 Ruby 的许可证或 GPL 使用、重新分发或更改这些文件。

你可以无限制地制作和赠送该软件源代码的完整副本，前提是你复制所有原始版权声明和相关免责声明。
你可以以任何方式修改你的软件副本，前提是你至少执行以下操作之一：
1. 将你的修改置于公共领域，或以其他方式使其免费可用，例如将修改发布到 Usenet 或类似的媒介，或允许作者将你的修改包含在软件中。
2. 仅在你的公司或组织内部使用修改后的软件。
3. 给非标准二进制文件使用非标准名称，并提供获取原始软件发行版的说明。
4. 与作者达成其他分发协议。
你可以以目标代码或二进制形式分发该软件，前提是你至少执行以下操作之一：
1. 分发该软件的二进制文件和库文件，同时提供有关（在手册页或同等文件中）从何处获取原始发行版的说明。
2. 随发行版附上该软件的机器可读源代码。
3. 给非标准二进制文件使用非标准名称，并提供获取原始软件发行版的说明。
4. 与作者达成其他分发协议。
你可以修改软件的一部分并将其包含在任何其他软件（可能是商业软件）中。但发行版中的某些文件并非作者编写，因此不受这些条款约束。

有关这些文件及其复制条件的列表，请参阅 LEGAL 文件。
作为该软件的输入或输出而提供的脚本和库文件不会自动属于该软件的版权，而是属于生成它们的人，并且可以进行商业销售，并可以与该软件聚合。
本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于对适销性和特定用途适用性的暗示担保。

公共类方法

parse (rd)

源代码

# File lib/rdoc/rd.rb, line 78
def self.parse rd
  rd = rd.lines.to_a

  if rd.find { |i| /\S/ === i } and !rd.find{|i| /^=begin\b/ === i } then
    rd.unshift("=begin\n").push("=end\n")
  end

  parser = RDoc::RD::BlockParser.new
  document = parser.parse rd

  # isn't this always true?
  document.parts.shift if RDoc::Markup::BlankLine === document.parts.first
  document.parts.pop   if RDoc::Markup::BlankLine === document.parts.last

  document
end

解析 rd 源代码并返回一个 RDoc::Markup::Document。如果缺少 =begin 或 =end 行，则将添加它们。