Class RI::SimpleFormatter
In: rdoc/ri/ri_formatter.rb
Parent: TextFormatter

This formatter reduces extra lines for a simpler output. It improves way output looks for tools like IRC bots.

Methods

blankline   display_heading   draw_line  

Public Instance methods

blankline()

No extra blank lines

[Source]

# File rdoc/ri/ri_formatter.rb, line 615
    def blankline
    end
display_heading(text, level, indent)

Place heading level indicators inline with heading.

[Source]

# File rdoc/ri/ri_formatter.rb, line 633
    def display_heading(text, level, indent)
      text = strip_attributes(text)
      case level
      when 1
        puts "= " + text.upcase
      when 2
        puts "-- " + text
      else
        print indent, text, "\n"
      end
    end
draw_line(label=nil)

Display labels only, no lines

[Source]

# File rdoc/ri/ri_formatter.rb, line 622
    def draw_line(label=nil)
      unless label.nil? then
        bold_print(label) 
        puts
      end
    end

[Validate]

ruby-doc.org is a community service provided by Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.