class RDoc::Markup::ToTableOfContents

从 RDoc::Markup::Document 中提取 RDoc::Markup::Heading 元素，以帮助构建目录

属性

omit_headings_below[RW]

省略级别低于给定级别的标题。

res[R]

输出累加器

公共类方法

to_toc() 点击切换源代码

用于生成目录的单例

# File rdoc/markup/to_table_of_contents.rb, line 13
def self.to_toc
  @to_toc ||= new
end

公共实例方法

accept_document(document) 点击切换源代码

将 document 添加到输出，如果存在则使用其标题截止

调用父类方法 RDoc::Markup::Formatter#accept_document

# File rdoc/markup/to_table_of_contents.rb, line 36
def accept_document document
  @omit_headings_below = document.omit_headings_below

  super
end

accept_heading(heading) 点击切换源代码

将 heading 添加到目录

# File rdoc/markup/to_table_of_contents.rb, line 45
def accept_heading heading
  @res << heading unless suppressed? heading
end

end_accepting() 点击切换源代码

返回目录

# File rdoc/markup/to_table_of_contents.rb, line 52
def end_accepting
  @res
end

start_accepting() 点击切换源代码

准备访问者以进行文本生成

# File rdoc/markup/to_table_of_contents.rb, line 59
def start_accepting
  @omit_headings_below = nil
  @res = []
end

suppressed?(heading) 点击切换源代码

如果 heading 低于显示阈值，则返回 true

# File rdoc/markup/to_table_of_contents.rb, line 67
def suppressed? heading
  return false unless @omit_headings_below

  heading.level > @omit_headings_below
end