A Document containing lists, headings, paragraphs, etc.

Methods
#
A
C
E
F
M
N
P
T
Included Modules
Attributes
[R] file

The file this document was created from. See also RDoc::ClassModule#add_comment
[RW] omit_headings_below

If a heading is below the given level it will be omitted from the #table_of_contents
[R] parts

The parts of the Document
Class Public methods
new(*parts)

Creates a new Document with parts

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 28
def initialize *parts
  @parts = []
  @parts.concat parts

  @file = nil
  @omit_headings_from_table_of_contents_below = nil
end
Instance Public methods
<<(part)

Appends part to the document

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 39
def << part
  case part
  when RDoc::Markup::Document then
    unless part.empty? then
      parts.concat part.parts
      parts << RDoc::Markup::BlankLine.new
    end
  when String then
    raise ArgumentError,
          "expected RDoc::Markup::Document and friends, got String" unless
      part.empty?
  else
    parts << part
  end
end
accept(visitor)

Runs this document and all its items through visitor

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 64
def accept visitor
  visitor.start_accepting

  visitor.accept_document self

  visitor.end_accepting
end
concat(parts)

Concatenates the given parts onto the document

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 75
def concat parts
  self.parts.concat parts
end
each(&block)

Enumerator for the parts of this document

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 82
def each &block
  @parts.each(&block)
end
empty?()

Does this document have no parts?

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 89
def empty?
  @parts.empty? or (@parts.length == 1 and merged? and @parts.first.empty?)
end
file=(location)

The file this Document was created from.

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 96
def file= location
  @file = case location
          when RDoc::TopLevel then
            location.relative_name
          else
            location
          end
end
merge(other)

When this is a collection of documents (#file is not set and this document contains only other documents as its direct children) merge replaces documents in this class with documents from other when the file matches and adds documents from other when the files do not.

The information in other is preferred over the receiver

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 113
def merge other
  if empty? then
    @parts = other.parts
    return self
  end

  other.parts.each do |other_part|
    self.parts.delete_if do |self_part|
      self_part.file and self_part.file == other_part.file
    end

    self.parts << other_part
  end

  self
end
merged?()

Does this Document contain other Documents?

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 133
def merged?
  RDoc::Markup::Document === @parts.first
end
push(*parts)

Appends parts to the document

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 150
def push *parts
  self.parts.concat parts
end
table_of_contents()

Returns an Array of headings in the document.

Require 'rdoc/markup/formatter' before calling this method.

Source: show | on GitHub 

# File lib/rdoc/markup/document.rb, line 159
def table_of_contents
  accept RDoc::Markup::ToTableOfContents.to_toc
end