class RDoc::Markup::List

A List is a homogeneous set of ListItems.

The supported list types include:

:BULLET: An unordered list
:LABEL: An unordered definition list, but using an alternate RDoc::Markup syntax
:LALPHA: An ordered list using increasing lowercase English letters
:NOTE: An unordered definition list
:NUMBER: An ordered list using increasing Arabic numerals
:UALPHA: An ordered list using increasing uppercase English letters

Definition lists behave like HTML definition lists. Each list item can describe multiple terms. See RDoc::Markup::ListItem for how labels and definitions are stored as list items.

Attributes

items [R]

Items in the list

: Array

type [RW]

The list's type

: Symbol?

Public Class Methods

new (type = nil, *items)

Creates a new list of +type+ with +items+. Valid list types are:
+:BULLET+, +:LABEL+, +:LALPHA+, +:NOTE+, +:NUMBER+, +:UALPHA+

: (Symbol?, *ListItem) -> void

# File lib/rdoc/markup/list.rb, line 37
def initialize(type = nil, *items)
  @type = type
  @items = items
end

Public Instance Methods

<< (item)

Appends +item+ to the list

: (ListItem) -> void

# File lib/rdoc/markup/list.rb, line 44
def <<(item)
  @items << item
end

accept (visitor)

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

: (untyped) -> void

# File lib/rdoc/markup/list.rb, line 58
def accept(visitor)
  visitor.accept_list_start(self)
  @items.each { |item| item.accept(visitor) }
  visitor.accept_list_end(self)
end

empty? ()

Is the list empty?

: () -> bool

# File lib/rdoc/markup/list.rb, line 66
def empty?
  @items.empty?
end

last ()

Returns the last item in the list

: () -> ListItem?

# File lib/rdoc/markup/list.rb, line 72
def last
  @items.last
end

push (*items)

Appends +items+ to the list

: (*ListItem) -> void

# File lib/rdoc/markup/list.rb, line 88
def push(*items)
  @items.concat(items)
end