RDoc::RI::OverstrikeFormatter

This formatter generates overstrike-style formatting, which works with pagers such as man and less.

Constants

BS

Public Instance Methods

bold_print(text) click to toggle source

Draw a string in bold

 
               # File rdoc/ri/formatter.rb, line 368
def bold_print(text)
  text.split(//).each do |ch|
    @output.print ch, BS, ch
  end
end

write_attribute_text(prefix, line) click to toggle source

 
               # File rdoc/ri/formatter.rb, line 352
def write_attribute_text(prefix, line)
  @output.print prefix

  line.each do |achar|
    attr = achar.attr
    @output.print "_", BS if (attr & (ITALIC + CODE)) != 0
    @output.print achar.char, BS if (attr & BOLD) != 0
    @output.print achar.char
  end

  @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::OverstrikeFormatter

Constants

Public Instance Methods