Maintenance of Ruby 2.0.0 will end on February 24, 2016. Read more

In Files

  • rdoc/markup/list.rb


Class/Module Index [+]



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

Public Class Methods

new(type = nil, *items) click to toggle source

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

               # File rdoc/markup/list.rb, line 39
def initialize type = nil, *items
  @type = type
  @items = []
  @items.concat items

Public Instance Methods

<<(item) click to toggle source

Appends item to the list

               # File rdoc/markup/list.rb, line 48
def << item
  @items << item
accept(visitor) click to toggle source

Runs this list and all its items through visitor

               # File rdoc/markup/list.rb, line 61
def accept visitor
  visitor.accept_list_start self

  @items.each do |item|
    item.accept visitor

  visitor.accept_list_end self
empty?() click to toggle source

Is the list empty?

               # File rdoc/markup/list.rb, line 74
def empty?
last() click to toggle source

Returns the last item in the list

               # File rdoc/markup/list.rb, line 81
def last
push(*items) click to toggle source

Appends items to the list

               # File rdoc/markup/list.rb, line 96
def push *items
  @items.concat items

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit

blog comments powered by Disqus