RDoc::RI::AnsiFormatter

This formatter uses ANSI escape sequences to colorize stuff works with pagers such as man and less.

Constants

ATTR_MAP
HEADINGS

Public Class Methods

new(*args) click to toggle source

 
               # File rdoc/ri/formatter.rb, line 382
def initialize(*args)
  super
  @output.print "\0033[0m"
end

Public Instance Methods

bold_print(txt) click to toggle source

 
               # File rdoc/ri/formatter.rb, line 402
def bold_print(txt)
  @output.print "\0033[1m#{txt}\0033[m"
end

display_heading(text, level, indent) click to toggle source

 
               # File rdoc/ri/formatter.rb, line 412
def display_heading(text, level, indent)
  level = 3 if level > 3
  heading = HEADINGS[level]
  @output.print indent
  @output.print heading[0]
  @output.print strip_attributes(text)
  @output.puts heading[1]
end

write_attribute_text(prefix, line) click to toggle source

 
               # File rdoc/ri/formatter.rb, line 387
def write_attribute_text(prefix, line)
  @output.print prefix
  curr_attr = 0
  line.each do |achar|
    attr = achar.attr
    if achar.attr != curr_attr
      update_attributes(achar.attr)
      curr_attr = achar.attr
    end
    @output.print achar.char
  end
  update_attributes(0) unless curr_attr.zero?
  @output.puts
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 see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Files

Class/Module Index

RDoc::RI::AnsiFormatter

Constants

Public Class Methods

Public Instance Methods