class RDoc::Markup::List

List 是 ListItems 的同质集合。

支持的列表类型包括

:BULLET: 无序列表
:LABEL: 无序定义列表，但使用另一种 RDoc::Markup 语法
:LALPHA: 使用递增的小写英文字母的有序列表
:NOTE: 无序定义列表
:NUMBER: 使用递增的阿拉伯数字的有序列表
:UALPHA: 使用递增的大写英文字母的有序列表

定义列表的行为类似于 HTML 定义列表。每个列表项可以描述多个术语。有关标签和定义如何存储为列表项的信息，请参阅 RDoc::Markup::ListItem。

属性

items[R]

列表中的项目

type[RW]

列表的类型

公共类方法

new(type = nil, *items) 点击切换源代码

使用 items 创建一个新的 type 列表。有效的列表类型为：:BULLET、:LABEL、:LALPHA、:NOTE、:NUMBER、:UALPHA

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

公共实例方法

<<(item) 点击切换源代码

将 item 追加到列表

# File rdoc/markup/list.rb, line 49
def << item
  @items << item
end

accept(visitor) 点击切换源代码

通过 visitor 运行此列表及其所有 items

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

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

  visitor.accept_list_end self
end

empty?() 点击切换源代码

列表是否为空？

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

last() 点击切换源代码

返回列表中的最后一项

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

push(*items) 点击切换源代码

将 items 追加到列表

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