rdoc 6.3.4.1 → 8.0.0

data/lib/rdoc/context/section.rb

@@ -1,232 +0,0 @@
-# frozen_string_literal: true
-##
-# A section of documentation like:
-#
-#   # :section: The title
-#   # The body
-#
-# Sections can be referenced multiple times and will be collapsed into a
-# single section.
-
-class RDoc::Context::Section
-
-  include RDoc::Text
-
-  MARSHAL_VERSION = 0 # :nodoc:
-
-  ##
-  # Section comment
-
-  attr_reader :comment
-
-  ##
-  # Section comments
-
-  attr_reader :comments
-
-  ##
-  # Context this Section lives in
-
-  attr_reader :parent
-
-  ##
-  # Section title
-
-  attr_reader :title
-
-  ##
-  # Creates a new section with +title+ and +comment+
-
-  def initialize parent, title, comment
-    @parent = parent
-    @title = title ? title.strip : title
-
-    @comments = []
-
-    add_comment comment
-  end
-
-  ##
-  # Sections are equal when they have the same #title
-
-  def == other
-    self.class === other and @title == other.title
-  end
-
-  alias eql? ==
-
-  ##
-  # Adds +comment+ to this section
-
-  def add_comment comment
-    comment = extract_comment comment
-
-    return if comment.empty?
-
-    case comment
-    when RDoc::Comment then
-      @comments << comment
-    when RDoc::Markup::Document then
-      @comments.concat comment.parts
-    when Array then
-      @comments.concat comment
-    else
-      raise TypeError, "unknown comment type: #{comment.inspect}"
-    end
-  end
-
-  ##
-  # Anchor reference for linking to this section
-
-  def aref
-    title = @title || '[untitled]'
-
-    CGI.escape(title).gsub('%', '-').sub(/^-/, '')
-  end
-
-  ##
-  # Extracts the comment for this section from the original comment block.
-  # If the first line contains :section:, strip it and use the rest.
-  # Otherwise remove lines up to the line containing :section:, and look
-  # for those lines again at the end and remove them. This lets us write
-  #
-  #   # :section: The title
-  #   # The body
-
-  def extract_comment comment
-    case comment
-    when Array then
-      comment.map do |c|
-        extract_comment c
-      end
-    when nil
-      RDoc::Comment.new ''
-    when RDoc::Comment then
-      if comment.text =~ /^#[ \t]*:section:.*\n/ then
-        start = $`
-        rest = $'
-
-        comment.text = if start.empty? then
-                         rest
-                       else
-                         rest.sub(/#{start.chomp}\Z/, '')
-                       end
-      end
-
-      comment
-    when RDoc::Markup::Document then
-      comment
-    else
-      raise TypeError, "unknown comment #{comment.inspect}"
-    end
-  end
-
-  def inspect # :nodoc:
-    "#<%s:0x%x %p>" % [self.class, object_id, title]
-  end
-
-  def hash # :nodoc:
-    @title.hash
-  end
-
-  ##
-  # The files comments in this section come from
-
-  def in_files
-    return [] if @comments.empty?
-
-    case @comments
-    when Array then
-      @comments.map do |comment|
-        comment.file
-      end
-    when RDoc::Markup::Document then
-      @comment.parts.map do |document|
-        document.file
-      end
-    else
-      raise RDoc::Error, "BUG: unknown comment class #{@comments.class}"
-    end
-  end
-
-  ##
-  # Serializes this Section.  The title and parsed comment are saved, but not
-  # the section parent which must be restored manually.
-
-  def marshal_dump
-    [
-      MARSHAL_VERSION,
-      @title,
-      parse,
-    ]
-  end
-
-  ##
-  # De-serializes this Section.  The section parent must be restored manually.
-
-  def marshal_load array
-    @parent  = nil
-
-    @title    = array[1]
-    @comments = array[2]
-  end
-
-  ##
-  # Parses +comment_location+ into an RDoc::Markup::Document composed of
-  # multiple RDoc::Markup::Documents with their file set.
-
-  def parse
-    case @comments
-    when String then
-      super
-    when Array then
-      docs = @comments.map do |comment, location|
-        doc = super comment
-        doc.file = location if location
-        doc
-      end
-
-      RDoc::Markup::Document.new(*docs)
-    when RDoc::Comment then
-      doc = super @comments.text, comments.format
-      doc.file = @comments.location
-      doc
-    when RDoc::Markup::Document then
-      return @comments
-    else
-      raise ArgumentError, "unknown comment class #{comments.class}"
-    end
-  end
-
-  ##
-  # The section's title, or 'Top Section' if the title is nil.
-  #
-  # This is used by the table of contents template so the name is silly.
-
-  def plain_html
-    @title || 'Top Section'
-  end
-
-  ##
-  # Removes a comment from this section if it is from the same file as
-  # +comment+
-
-  def remove_comment comment
-    return if @comments.empty?
-
-    case @comments
-    when Array then
-      @comments.delete_if do |my_comment|
-        my_comment.file == comment.file
-      end
-    when RDoc::Markup::Document then
-      @comments.parts.delete_if do |document|
-        document.file == comment.file.name
-      end
-    else
-      raise RDoc::Error, "BUG: unknown comment class #{@comments.class}"
-    end
-  end
-
-end
-

data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml

@@ -1,19 +0,0 @@
-<%- if !svninfo.empty? then %>
-<div id="file-svninfo-section" class="nav-section">
-  <h3>VCS Info</h3>
-
-  <div class="section-body">
-    <dl class="svninfo">
-      <dt>Rev
-      <dd><%= svninfo[:rev] %>
-
-      <dt>Last Checked In
-      <dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
-        (<%= svninfo[:commitdelta] %> ago)
-
-      <dt>Checked in by
-      <dd><%= svninfo[:committer] %>
-    </dl>
-  </div>
-</div>
-<%- end -%>

data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml

@@ -1,9 +0,0 @@
-<div id="file-list-section" class="nav-section">
-  <h3>Defined In</h3>
-
-  <ul>
-<%- klass.in_files.each do |tl| -%>
-    <li><%= h tl.relative_name %>
-<%- end -%>
-  </ul>
-</div>

data/lib/rdoc/generator/template/json_index/.document

@@ -1 +0,0 @@
-# ignore all files in this directory

data/lib/rdoc/ghost_method.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-##
-# GhostMethod represents a method referenced only by a comment
-
-class RDoc::GhostMethod < RDoc::AnyMethod
-end
-

data/lib/rdoc/markup/attr_changer.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-class RDoc::Markup
-
-  AttrChanger = Struct.new :turn_on, :turn_off # :nodoc:
-
-end
-
-##
-# An AttrChanger records a change in attributes. It contains a bitmap of the
-# attributes to turn on, and a bitmap of those to turn off.
-
-class RDoc::Markup::AttrChanger
-
-  def to_s # :nodoc:
-    "Attr: +#{turn_on}/-#{turn_off}"
-  end
-
-  def inspect # :nodoc:
-    '+%d/-%d' % [turn_on, turn_off]
-  end
-
-end
-

data/lib/rdoc/markup/attr_span.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-##
-# An array of attributes which parallels the characters in a string.
-
-class RDoc::Markup::AttrSpan
-
-  ##
-  # Creates a new AttrSpan for +length+ characters
-
-  def initialize(length, exclusive)
-    @attrs = Array.new(length, 0)
-    @exclusive = exclusive
-  end
-
-  ##
-  # Toggles +bits+ from +start+ to +length+
-  def set_attrs(start, length, bits)
-    updated = false
-    for i in start ... (start+length)
-      if (@exclusive & @attrs[i]) == 0 || (@exclusive & bits) != 0
-        @attrs[i] |= bits
-        updated = true
-      end
-    end
-    updated
-  end
-
-  ##
-  # Accesses flags for character +n+
-
-  def [](n)
-    @attrs[n]
-  end
-
-end
-