class RDoc::TomDoc

基于 TomDoc 1.0.0-rc1 (02adef9b5a) 的 TomDoc 解析器

TomDoc 规范可以在 tomdoc.org 找到。

要选择 TomDoc 作为您唯一的默认格式,请参阅 RDoc::Options 的已保存选项,了解如何设置 .rdoc_options 文件以存储您的项目默认设置。

此解析器与规范之间存在一些差异。我们尽最大努力尽可能遵循规范,但做出了一些偏离的选择。

当违反 MUST 或 MUST NOT 时,未来版本的 RDoc 将发出警告,并且在违反 SHOULD 或 SHOULD NOT 时可能会发出警告。RDoc 始终会尝试发出文档,即使给定无效的 TomDoc

以下是此解析器当前做出的一些实现选择

此解析器允许 rdoc 风格的内联标记,但您不应依赖它。

此解析器允许在注释和方法主体之间存在空格。

此解析器不要求为可选参数描述默认值。

此解析器不检查各章节的顺序。“示例”章节可能位于“参数”章节之前。

此类以 TomDoc 格式记录。由于这是 RDoc 标记解析器的子类,因此不幸的是,这里没有什么可看的。