RDoc::Markup::Verbatim

A section of verbatim text

Public Instance Methods

accept(visitor) click to toggle source

Calls accept_verbatim on visitor

 
               # File rdoc/markup/verbatim.rb, line 9
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 16
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

text() click to toggle source

The text of the section

 
               # File rdoc/markup/verbatim.rb, line 40
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 see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Class/Module Index

RDoc::Markup::Verbatim

Public Instance Methods