Extracts just the RDoc::Markup::Heading elements from a RDoc::Markup::Document to help build a table of contents
Omits headings with a level less than the given level.
Output accumulator
Singleton for table-of-contents generation
# File lib/rdoc/markup/to_table_of_contents.rb, line 12 def self.to_toc @to_toc ||= new end
Adds document
to the output, using its heading cutoff if
present
# File lib/rdoc/markup/to_table_of_contents.rb, line 35 def accept_document document @omit_headings_below = document.omit_headings_below super end
Adds heading
to the table of contents
# File lib/rdoc/markup/to_table_of_contents.rb, line 44 def accept_heading heading @res << heading unless suppressed? heading end
Returns the table of contents
# File lib/rdoc/markup/to_table_of_contents.rb, line 51 def end_accepting @res end
Prepares the visitor for text generation
# File lib/rdoc/markup/to_table_of_contents.rb, line 58 def start_accepting @omit_headings_below = nil @res = [] end
Returns true if heading
is below the display threshold
# File lib/rdoc/markup/to_table_of_contents.rb, line 66 def suppressed? heading return false unless @omit_headings_below heading.level > @omit_headings_below end