Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://ruby.github.io/rdoc/RDoc/Markup/Document.html below:

class RDoc::Markup::Document - rdoc Documentation

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

Appends part to the document

def accept(visitor)
  visitor.start_accepting

  visitor.accept_document self

  visitor.end_accepting
end

Runs this document and all its items through visitor

def concat(parts)
  self.parts.concat parts
end

Concatenates the given parts onto the document

def each(&block)
  @parts.each(&block)
end

Enumerator for the parts of this document

def empty?
  @parts.empty? or (@parts.length == 1 and merged? and @parts.first.empty?)
end

Does this document have no parts?

def file=(location)
  @file = case location
          when RDoc::TopLevel then
            location.relative_name
          else
            location
          end
end

The file this Document was created from.

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

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

def merged?
  RDoc::Markup::Document === @parts.first
end

Does this Document contain other Documents?

def push *parts
  self.parts.concat parts
end

Appends parts to the document

def table_of_contents
  accept RDoc::Markup::ToTableOfContents.to_toc
end

Returns an Array of headings in the document.

Require ‘rdoc/markup/formatter’ before calling this method.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4