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

Methods
#
A
E
L
N
P
Attributes
[RW] label

The label for the ListItem
[R] parts

Parts of the ListItem
Class Public methods
new(label = nil, *parts)

Creates a new ListItem with an optional label containing parts

Source: show | on GitHub 

# File lib/rdoc/markup/list_item.rb, line 26
def initialize label = nil, *parts
  @label = label
  @parts = []
  @parts.concat parts
end
Instance Public methods
<<(part)

Appends part to the ListItem

Source: show | on GitHub 

# File lib/rdoc/markup/list_item.rb, line 35
def << part
  @parts << part
end
accept(visitor)

Runs this list item and all its parts through visitor

Source: show | on GitHub 

# File lib/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?()

Is the ListItem empty?

Source: show | on GitHub 

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

Length of parts in the ListItem

Source: show | on GitHub 

# File lib/rdoc/markup/list_item.rb, line 68
def length
  @parts.length
end
push(*parts)

Adds parts to the ListItem

Source: show | on GitHub 

# File lib/rdoc/markup/list_item.rb, line 94
def push *parts
  @parts.concat parts
end