RDoc::Markup::

ToTtOnly

class

Extracts sections of text enclosed in plus, tt or code. Used to discover undocumented parameters.

Attributes

list_type[R]

Stack of list types

res[R]

Output accumulator

Public Class Methods

new(markup = nil)

Creates a new tt-only formatter.

# File lib/rdoc/markup/to_tt_only.rb, line 20
def initialize markup = nil
  super

  add_tag :TT, nil, nil
end

Public Instance Methods

accept_blank_line(markup_item)
Alias for: do_nothing
accept_heading(markup_item)
Alias for: do_nothing
accept_list_end(list)

Pops the list type for list from list_type

# File lib/rdoc/markup/to_tt_only.rb, line 29
def accept_list_end list
  @list_type.pop
end
accept_list_item_end(markup_item)
Alias for: do_nothing
accept_list_item_start(list_item)

Prepares the visitor for consuming list_item

# File lib/rdoc/markup/to_tt_only.rb, line 43
def accept_list_item_start list_item
  case @list_type.last
  when :NOTE, :LABEL then
    Array(list_item.label).map do |label|
      tt_sections label
    end.flatten
  end
end
accept_list_start(list)

Pushes the list type for list onto list_type

# File lib/rdoc/markup/to_tt_only.rb, line 36
def accept_list_start list
  @list_type << list.type
end
accept_paragraph(paragraph)

Adds paragraph to the output

# File lib/rdoc/markup/to_tt_only.rb, line 55
def accept_paragraph paragraph
  tt_sections(paragraph.text)
end
accept_raw(markup_item)
Alias for: do_nothing
accept_rule(markup_item)
Alias for: do_nothing
accept_verbatim(markup_item)
Alias for: do_nothing
do_nothing(markup_item)

Does nothing to markup_item because it doesn’t have any user-built content

# File lib/rdoc/markup/to_tt_only.rb, line 63
def do_nothing markup_item
end
Also aliased as: accept_blank_line , accept_heading , accept_list_item_end , accept_raw , accept_rule , accept_verbatim
end_accepting()

Returns an Array of items that were wrapped in plus, tt or code.

# File lib/rdoc/markup/to_tt_only.rb, line 99
def end_accepting
  @res.compact
end
start_accepting()

Prepares the visitor for gathering tt sections

# File lib/rdoc/markup/to_tt_only.rb, line 106
def start_accepting
  @res = []

  @list_type = []
end
tt_sections(text)

Extracts tt sections from text

# File lib/rdoc/markup/to_tt_only.rb, line 76
def tt_sections text
  flow = @am.flow text.dup

  flow.each do |item|
    case item
    when String then
      @res << item if in_tt?
    when RDoc::Markup::AttrChanger then
      off_tags res, item
      on_tags res, item
    when RDoc::Markup::Special then
      @res << convert_special(item) if in_tt? # TODO can this happen?
    else
      raise "Unknown flow element: #{item.inspect}"
    end
  end

  res
end