Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • rdoc/ri/ri_formatter.rb

Files

Class/Module Index [+]

Quicksearch

RI::SimpleFormatter

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

Public Instance Methods

blankline() click to toggle source

No extra blank lines

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

Place heading level indicators inline with heading.

 
               # 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) click to toggle source

Display labels only, no lines

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

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus