### Home Classes Methods

### In Files

- lib/rdoc/markup/to_tt_only.rb

### Parent

RDoc::Markup::Formatter

### Methods

- ::new
- #accept_blank_line
- #accept_block_quote
- #accept_heading
- #accept_list_end
- #accept_list_item_end
- #accept_list_item_start
- #accept_list_start
- #accept_paragraph
- #accept_raw
- #accept_rule
- #accept_verbatim
- #do_nothing
- #end_accepting
- #start_accepting
- #tt_sections

### Files

- CONTRIBUTING.rdoc
- CVE-2013-0256.rdoc
- ExampleRDoc.rdoc
- LICENSE.rdoc
- Manifest.txt
- README.rdoc
- RI.rdoc
- Rakefile
- TODO.rdoc

### Class/Module Index

Quicksearch

- RDoc
- RDoc::Alias
- RDoc::AnonClass
- RDoc::AnyMethod
- RDoc::Attr
- RDoc::ClassModule
- RDoc::CodeObject
- RDoc::Comment
- RDoc::Constant
- RDoc::Context
- RDoc::Context::Section
- RDoc::CrossReference
- RDoc::ERBIO
- RDoc::ERBPartial
- RDoc::Encoding
- RDoc::Error
- RDoc::Extend
- RDoc::Gauntlet
- RDoc::Generator
- RDoc::Generator::Darkfish
- RDoc::Generator::JsonIndex
- RDoc::Generator::Markup
- RDoc::Generator::RI
- RDoc::GhostMethod
- RDoc::Include
- RDoc::Markdown
- RDoc::Markdown::Literals
- RDoc::Markup
- RDoc::Markup::AttrChanger
- RDoc::Markup::AttrSpan
- RDoc::Markup::AttributeManager
- RDoc::Markup::Attributes
- RDoc::Markup::BlankLine
- RDoc::Markup::BlockQuote
- RDoc::Markup::Document
- RDoc::Markup::Formatter
- RDoc::Markup::FormatterTestCase
- RDoc::Markup::HardBreak
- RDoc::Markup::Include
- RDoc::Markup::IndentedParagraph
- RDoc::Markup::List
- RDoc::Markup::ListItem
- RDoc::Markup::Paragraph
- RDoc::Markup::Parser
- RDoc::Markup::Parser::Error
- RDoc::Markup::Parser::ParseError
- RDoc::Markup::PreProcess
- RDoc::Markup::Raw
- RDoc::Markup::Rule
- RDoc::Markup::Special
- RDoc::Markup::TextFormatterTestCase
- RDoc::Markup::ToAnsi
- RDoc::Markup::ToBs
- RDoc::Markup::ToHtml
- RDoc::Markup::ToHtmlCrossref
- RDoc::Markup::ToHtmlSnippet
- RDoc::Markup::ToJoinedParagraph
- RDoc::Markup::ToLabel
- RDoc::Markup::ToMarkdown
- RDoc::Markup::ToRdoc
- RDoc::Markup::ToTableOfContents
- RDoc::Markup::ToTest
- RDoc::Markup::ToTtOnly
- RDoc::Markup::Verbatim
- RDoc::MetaMethod
- RDoc::MethodAttr
- RDoc::Mixin
- RDoc::NormalClass
- RDoc::NormalModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::Parser::ChangeLog
- RDoc::Parser::Markdown
- RDoc::Parser::RD
- RDoc::Parser::Ruby
- RDoc::Parser::RubyTools
- RDoc::Parser::Simple
- RDoc::Parser::Text
- RDoc::RD
- RDoc::RD::BlockParser
- RDoc::RD::Inline
- RDoc::RD::InlineParser
- RDoc::RDoc
- RDoc::RI
- RDoc::RI::Driver
- RDoc::RI::Driver::Error
- RDoc::RI::Driver::NotFoundError
- RDoc::RI::Error
- RDoc::RI::Paths
- RDoc::Require
- RDoc::RubyLex
- RDoc::RubyLex::Error
- RDoc::RubyToken
- RDoc::RubygemsHook
- RDoc::Servlet
- RDoc::SingleClass
- RDoc::Stats
- RDoc::Stats::Normal
- RDoc::Stats::Quiet
- RDoc::Stats::Verbose
- RDoc::Store
- RDoc::Store::Error
- RDoc::Store::MissingFileError
- RDoc::Task
- RDoc::Task
- RDoc::TestCase
- RDoc::TokenStream
- RDoc::TomDoc
- RDoc::TopLevel
- Object

No matching classes.

# RDoc::Markup::ToTtOnly

Extracts sections of text enclosed in plus, tt or code. Used to discover undocumented parameters.

### Attributes

list_type[R]

Stack of list types

res[R]

Output accumulator

### Public Class Methods

new(markup = nil) click to toggle source

Creates a new tt-only formatter.

    # File lib/rdoc/markup/to_tt_only.rb, line 20
    def initialize markup = nil
      super nil, markup

      add_tag :TT, nil, nil
    end

### Public Instance Methods

accept_blank_line(markup_item) click to toggle source
Alias for: do_nothing
accept_block_quote(block_quote) click to toggle source

Adds tts from `block_quote` to the output

    # File lib/rdoc/markup/to_tt_only.rb, line 29
    def accept_block_quote block_quote
      tt_sections block_quote.text
    end

accept_heading(markup_item) click to toggle source
Alias for: do_nothing
accept_list_end(list) click to toggle source

Pops the list type for `list` from list_type

    # File lib/rdoc/markup/to_tt_only.rb, line 36
    def accept_list_end list
      @list_type.pop
    end

accept_list_item_end(markup_item) click to toggle source
Alias for: do_nothing
accept_list_item_start(list_item) click to toggle source

Prepares the visitor for consuming `list_item`

    # File lib/rdoc/markup/to_tt_only.rb, line 50
    def accept_list_item_start list_item
      case @list_type.last
      when :NOTE, :LABEL then
        Array(list_item.label).map do |label|
          tt_sections label
        end.flatten
      end
    end

accept_list_start(list) click to toggle source

Pushes the list type for `list` onto list_type

    # File lib/rdoc/markup/to_tt_only.rb, line 43
    def accept_list_start list
      @list_type << list.type
    end

accept_paragraph(paragraph) click to toggle source

Adds `paragraph` to the output

    # File lib/rdoc/markup/to_tt_only.rb, line 62
    def accept_paragraph paragraph
      tt_sections(paragraph.text)
    end

accept_raw(markup_item) click to toggle source
Alias for: do_nothing
accept_rule(markup_item) click to toggle source
Alias for: do_nothing
accept_verbatim(markup_item) click to toggle source
Alias for: do_nothing
do_nothing(markup_item) click to toggle source

Does nothing to `markup_item` because it doesn't have any user-built content

    # File lib/rdoc/markup/to_tt_only.rb, line 70
    def do_nothing markup_item
    end

Also aliased as: accept_blank_line, accept_heading, accept_list_item_end, accept_raw, accept_rule, accept_verbatim
end_accepting() click to toggle source

Returns an Array of items that were wrapped in plus, tt or code.

    # File lib/rdoc/markup/to_tt_only.rb, line 106
    def end_accepting
      @res.compact
    end

start_accepting() click to toggle source

Prepares the visitor for gathering tt sections

    # File lib/rdoc/markup/to_tt_only.rb, line 113
    def start_accepting
      @res = []

      @list_type = []
    end

tt_sections(text) click to toggle source

Extracts tt sections from `text`

    # File lib/rdoc/markup/to_tt_only.rb, line 83
    def tt_sections text
      flow = @am.flow text.dup

      flow.each do |item|
        case item
        when String then
          @res << item if in_tt?
        when RDoc::Markup::AttrChanger then
          off_tags res, item
          on_tags res, item
        when RDoc::Markup::Special then
          @res << convert_special(item) if in_tt? # TODO can this happen?
        else
          raise "Unknown flow element: #{item.inspect}"
        end
      end

      res
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.