RDoc::Markup::IndentedParagraph

An Indented Paragraph of text

Attributes

indent[R]

The indent in number of spaces

Public Class Methods

new(indent, *parts) click to toggle source

Creates a new IndentedParagraph containing parts indented with indent spaces

 
               # File rdoc/markup/indented_paragraph.rb, line 15
def initialize indent, *parts
  @indent = indent

  super(*parts)
end

Public Instance Methods

accept(visitor) click to toggle source

Calls accept_indented_paragraph on visitor

 
               # File rdoc/markup/indented_paragraph.rb, line 28
def accept visitor
  visitor.accept_indented_paragraph self
end

text(hard_break = nil) click to toggle source

Joins the raw paragraph text and converts inline HardBreaks to the hard_break text followed by the indent.

 
               # File rdoc/markup/indented_paragraph.rb, line 36
def text hard_break = nil
  @parts.map do |part|
    if RDoc::Markup::HardBreak === part then
      '%1$s%3$*2$s' % [hard_break, @indent, ' '] if hard_break
    else
      part
    end
  end.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::IndentedParagraph

Attributes

Public Class Methods

Public Instance Methods