In Files

  • rdoc/markup/verbatim.rb

Class/Module Index [+]

Quicksearch

RDoc::Markup::Verbatim

A section of verbatim text

Attributes

format[RW]

Format of this verbatim section

Public Instance Methods

accept(visitor) click to toggle source

Calls accept_verbatim on visitor

 
               # File rdoc/markup/verbatim.rb, line 24
def accept visitor
  visitor.accept_verbatim self
end
            
normalize() click to toggle source

Collapses 3+ newlines into two newlines

 
               # File rdoc/markup/verbatim.rb, line 31
def normalize
  parts = []

  newlines = 0

  @parts.each do |part|
    case part
    when /^\s*\n/ then
      newlines += 1
      parts << part if newlines == 1
    else
      newlines = 0
      parts << part
    end
  end

  parts.pop if parts.last =~ /\A\r?\n\z/

  @parts = parts
end
            
ruby?() click to toggle source

Is this verbatim section Ruby code?

 
               # File rdoc/markup/verbatim.rb, line 70
def ruby?
  @format ||= nil # TODO for older ri data, switch the tree to marshal_dump
  @format == :ruby
end
            
text() click to toggle source

The text of the section

 
               # File rdoc/markup/verbatim.rb, line 78
def text
  @parts.join
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