RDoc::Markup::ListItem

An item within a List that contains paragraphs, headings, etc.

For BULLET, NUMBER, LALPHA and UALPHA lists, the label will always be nil. For NOTE and LABEL lists, the list label may contain:

a single String for a single label
an Array of Strings for a list item with multiple terms
nil for an extra description attached to a previously labeled list item

Attributes

label[RW]

The label for the ListItem

parts[R]

Parts of the ListItem

Public Class Methods

new(label = nil, *parts) click to toggle source

Creates a new ListItem with an optional label containing parts

 
               # File rdoc/markup/list_item.rb, line 26
def initialize label = nil, *parts
  @label = label
  @parts = []
  @parts.concat parts
end

Public Instance Methods

<<(part) click to toggle source

Appends part to the ListItem

 
               # File rdoc/markup/list_item.rb, line 35
def << part
  @parts << part
end

accept(visitor) click to toggle source

Runs this list item and all its parts through visitor

 
               # File rdoc/markup/list_item.rb, line 48
def accept visitor
  visitor.accept_list_item_start self

  @parts.each do |part|
    part.accept visitor
  end

  visitor.accept_list_item_end self
end

empty?() click to toggle source

Is the ListItem empty?

 
               # File rdoc/markup/list_item.rb, line 61
def empty?
  @parts.empty?
end

length() click to toggle source

Length of parts in the ListItem

 
               # File rdoc/markup/list_item.rb, line 68
def length
  @parts.length
end

push(*parts) click to toggle source

Adds parts to the ListItem

 
               # File rdoc/markup/list_item.rb, line 94
def push *parts
  @parts.concat parts
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::ListItem

Attributes

Public Class Methods

Public Instance Methods