class 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

: (Array | String)?

parts [R]

Parts of the ListItem

Public Class Methods

new (label = nil, *parts)

Source

# File lib/rdoc/markup/list_item.rb, line 23
def initialize(label = nil, *parts)
  @label = label
  @parts = parts
end

Creates a new ListItem with an optional +label+ containing +parts+

: ((Array | String)?, *Element) -> void

Public Instance Methods

<< (part)

Source

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

Appends +part+ to the ListItem

: (Element) -> void

accept (visitor)

Source

# File lib/rdoc/markup/list_item.rb, line 44
def accept(visitor)
  visitor.accept_list_item_start(self)
  @parts.each { |part| part.accept(visitor) }
  visitor.accept_list_item_end(self)
end

Runs this list item and all its #parts through +visitor+
@override

: (untyped) -> void

empty? ()

Source

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

Is the ListItem empty?

: () -> bool

length ()

Source

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

Length of parts in the ListItem

: () -> Integer

push (*parts)

Source

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

Adds +parts+ to the ListItem

: (*Element) -> void