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] (Array[String] | String)?

The label for the ListItem

parts [R] Array[untyped]

Parts of the ListItem

Public Class Methods

new (label = nil, *parts)

((Array[String] | String)?, *untyped) → void

Source

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

Creates a new ListItem with an optional label containing parts

Public Instance Methods

<< (part)

(untyped) → void

Source

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

Appends part to the ListItem

accept (visitor)

(untyped) → void

Source

# File lib/rdoc/markup/list_item.rb, line 45
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

empty? ()

() → bool

Source

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

Is the ListItem empty?

length ()

() → Integer

Source

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

Length of parts in the ListItem

push (*parts)

(*untyped) → void

Source

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

Adds parts to the ListItem