A List is a homogeneous set of ListItems.
The supported list types include:
An unordered list
An unordered definition list, but using an alternate RDoc::Markup syntax
An ordered list using increasing lowercase English letters
An unordered definition list
An ordered list using increasing Arabic numerals
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 definition are stored as list items.
Items in the list
The list's type
Creates a new list of type
with items
. Valid
list types are: :BULLET
, :LABEL
,
:LALPHA
, :NOTE
, :NUMBER
,
:UALPHA
# File lib/rdoc/markup/list.rb, line 39 def initialize type = nil, *items @type = type @items = [] @items.concat items end
Appends item
to the list
# File lib/rdoc/markup/list.rb, line 48 def << item @items << item end
Runs this list and all its items
through visitor
# File lib/rdoc/markup/list.rb, line 61 def accept visitor visitor.accept_list_start self @items.each do |item| item.accept visitor end visitor.accept_list_end self end
Is the list empty?
# File lib/rdoc/markup/list.rb, line 74 def empty? @items.empty? end
Returns the last item in the list
# File lib/rdoc/markup/list.rb, line 81 def last @items.last end
Appends items
to the list
# File lib/rdoc/markup/list.rb, line 96 def push *items @items.concat items end