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] Array[ListItem]

Items in the list

type [RW] Symbol?

The list’s type

Public Class Methods

new (type = nil, *items)

(Symbol?, *ListItem) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rdoc-8.1.0/lib/rdoc/markup/list.rb, line 37
def initialize(type = nil, *items)
  @type = type
  @items = items
end

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

Public Instance Methods

<< (item)

(ListItem) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rdoc-8.1.0/lib/rdoc/markup/list.rb, line 44
def <<(item)
  @items << item
end

Appends item to the list

accept (visitor)

(untyped) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rdoc-8.1.0/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

Runs this list and all its items through visitor @override

empty? ()

() → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rdoc-8.1.0/lib/rdoc/markup/list.rb, line 66
def empty?
  @items.empty?
end

Is the list empty?

last ()

() → ListItem?

Source

# File vendor/bundle/ruby/4.0.0/gems/rdoc-8.1.0/lib/rdoc/markup/list.rb, line 72
def last
  @items.last
end

Returns the last item in the list

push (*items)

(*ListItem) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rdoc-8.1.0/lib/rdoc/markup/list.rb, line 88
def push(*items)
  @items.concat(items)
end

Appends items to the list