Class RDoc::RI::OverstrikeFormatter

  1. lib/rdoc/ri/formatter.rb
Parent: RDoc::RI::AttributeFormatter
ClassModule NormalModule AnonClass SingleClass NormalClass AnyMethod GhostMethod MetaMethod CodeObject Context Alias Attr Constant Require Include TopLevel RubyLex IRB RuntimeError Error Error Token TkUnknownChar TkVal TkNode TkOp TkId TkError TkOPASGN TkKW AttributeFormatter HtmlFormatter OverstrikeFormatter AnsiFormatter NamedThing AliasName IncludedModule Constant Attribute MethodSummary DefaultDisplay ClassEntry TopLevelEntry Formatter SimpleFormatter Description MethodDescription ModuleDescription ClassDescription HTML XML HTMLInOne CHM Method Context Class File Generator::MarkUp TEXINFO SimpleElement Port Element Node Subgraph Edge Digraph Stats Parser Options RDoc TemplatePage Markup Diagram NameDescriptor Cache Reader Writer Driver MethodEntry RI TexinfoTemplate AllReferences RubyToken Display Paths RI MarkUp Generator TokenStream DOT RDoc dot/f_5.png

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

Methods

public instance

  1. bold_print
  2. write_attribute_text

Constants

BS = "\C-h"

Public instance methods

bold_print (text)

Draw a string in bold

[show source] 
# File lib/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)
[show source] 
# File lib/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