RubyGems - rdoc - Versions diffs - 6.7.0 → 6.12.0 - Mend

rdoc 6.7.0 → 6.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

checksums.yaml +4 -4
data/ExampleMarkdown.md +2 -0
data/ExampleRDoc.rdoc +2 -0
data/History.rdoc +64 -62
data/LICENSE.rdoc +2 -0
data/README.rdoc +13 -0
data/RI.md +842 -0
data/TODO.rdoc +8 -7
data/lib/rdoc/{alias.rb → code_object/alias.rb} +1 -1
data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +3 -3
data/lib/rdoc/{attr.rb → code_object/attr.rb} +1 -1
data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +82 -12
data/lib/rdoc/{constant.rb → code_object/constant.rb} +1 -1
data/lib/rdoc/{context → code_object/context}/section.rb +10 -68
data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +17 -5
data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +5 -5
data/lib/rdoc/code_object.rb +6 -1
data/lib/rdoc/comment.rb +11 -1
data/lib/rdoc/generator/darkfish.rb +41 -3
data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
data/lib/rdoc/generator/pot/po_entry.rb +1 -1
data/lib/rdoc/generator/template/darkfish/_head.rhtml +23 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +1 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +3 -8
data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
data/lib/rdoc/generator/template/darkfish/class.rhtml +69 -43
data/lib/rdoc/generator/template/darkfish/css/rdoc.css +380 -399
data/lib/rdoc/generator/template/darkfish/index.rhtml +11 -10
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +24 -1
data/lib/rdoc/generator/template/darkfish/page.rhtml +5 -5
data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +10 -8
data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +5 -2
data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +11 -0
data/lib/rdoc/markdown.kpeg +1 -1
data/lib/rdoc/markdown.rb +21 -11
data/lib/rdoc/markup/attribute_manager.rb +2 -2
data/lib/rdoc/markup/formatter.rb +19 -12
data/lib/rdoc/markup/pre_process.rb +26 -6
data/lib/rdoc/markup/to_bs.rb +1 -1
data/lib/rdoc/markup/to_html.rb +1 -1
data/lib/rdoc/markup/to_html_crossref.rb +63 -12
data/lib/rdoc/markup/to_rdoc.rb +5 -5
data/lib/rdoc/markup.rb +18 -13
data/lib/rdoc/options.rb +78 -12
data/lib/rdoc/parser/c.rb +26 -2
data/lib/rdoc/parser/changelog.rb +5 -4
data/lib/rdoc/parser/prism_ruby.rb +1099 -0
data/lib/rdoc/parser/ripper_state_lex.rb +7 -305
data/lib/rdoc/parser/ruby.rb +16 -7
data/lib/rdoc/parser/simple.rb +1 -1
data/lib/rdoc/parser.rb +5 -4
data/lib/rdoc/rd/block_parser.rb +3 -3
data/lib/rdoc/rd/inline_parser.rb +3 -3
data/lib/rdoc/rdoc.rb +6 -3
data/lib/rdoc/ri/driver.rb +74 -29
data/lib/rdoc/rubygems_hook.rb +90 -8
data/lib/rdoc/store.rb +12 -0
data/lib/rdoc/task.rb +2 -3
data/lib/rdoc/tom_doc.rb +1 -7
data/lib/rdoc/version.rb +1 -1
data/lib/rdoc.rb +22 -24
data/lib/rubygems_plugin.rb +23 -0
metadata +27 -26
data/RI.rdoc +0 -57
data/lib/rdoc/generator/template/darkfish/.document +0 -0
data/lib/rdoc/generator/template/json_index/.document +0 -1
/data/lib/rdoc/{anon_class.rb → code_object/anon_class.rb} +0 -0
/data/lib/rdoc/{context.rb → code_object/context.rb} +0 -0
/data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -0
/data/lib/rdoc/{ghost_method.rb → code_object/ghost_method.rb} +0 -0
/data/lib/rdoc/{include.rb → code_object/include.rb} +0 -0
/data/lib/rdoc/{meta_method.rb → code_object/meta_method.rb} +0 -0
/data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +0 -0
/data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +0 -0
/data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +0 -0
/data/lib/rdoc/{require.rb → code_object/require.rb} +0 -0
/data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +0 -0

data/lib/rdoc/generator/template/darkfish/index.rhtml CHANGED Viewed

@@ -1,22 +1,23 @@
 <body id="top" role="document" class="file">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <%= render '_sidebar_navigation.rhtml' %>
     <%= render '_sidebar_search.rhtml' %>
   </div>
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-    <%= render '_sidebar_classes.rhtml' %>
-  </div>
+  <%= render '_sidebar_table_of_contents.rhtml' if defined?(current) %>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">
-<%- if @options.main_page and
-      main_page = @files.find { |f| f.full_name == @options.main_page } then %>
-<%= main_page.description %>
+<%- if @main_page %>
+  <%= @main_page.description %>
 <%- else -%>
-<p>This is the API documentation for <%= h @title %>.
+  <p>This is the API documentation for <%= h @title %>.
 <%- end -%>
 </main>

data/lib/rdoc/generator/template/darkfish/js/darkfish.js CHANGED Viewed

@@ -34,7 +34,7 @@ function showSource( e ) {
 };
 function hookSourceViews() {
-  document.querySelectorAll('.method-heading').forEach(function (codeObject) {
+  document.querySelectorAll('.method-source-toggle').forEach(function (codeObject) {
     codeObject.addEventListener('click', showSource);
   });
 };
@@ -90,8 +90,31 @@ function hookFocus() {
   });
 }
+function hookSidebar() {
+  var navigation = document.querySelector('#navigation');
+  var navigationToggle = document.querySelector('#navigation-toggle');
+  navigationToggle.addEventListener('click', function() {
+    navigation.hidden = !navigation.hidden;
+    navigationToggle.ariaExpanded = navigationToggle.ariaExpanded !== 'true';
+  });
+  var isSmallViewport = window.matchMedia("(max-width: 1023px)").matches;
+  if (isSmallViewport) {
+    navigation.hidden = true;
+    navigationToggle.ariaExpanded = false;
+    document.addEventListener('click', (e) => {
+      if (e.target.closest('#navigation a')) {
+        navigation.hidden = true;
+        navigationToggle.ariaExpanded = false;
+      }
+    });
+  }
+}
 document.addEventListener('DOMContentLoaded', function() {
   hookSourceViews();
   hookSearch();
   hookFocus();
+  hookSidebar();
 });

data/lib/rdoc/generator/template/darkfish/page.rhtml CHANGED Viewed

@@ -1,18 +1,18 @@
 <body id="top" role="document" class="file">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <%= render '_sidebar_navigation.rhtml' %>
     <%= render '_sidebar_search.rhtml' %>
   </div>
   <%= render '_sidebar_table_of_contents.rhtml' %>
+  <%= render '_sidebar_pages.rhtml' %>
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-  </div>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main" aria-label="Page <%=h file.full_name%>">
 <%= file.description %>
 </main>

data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml CHANGED Viewed

@@ -1,13 +1,16 @@
 <body role="document">
-<nav role="navigation">
-  <%= render '_sidebar_navigation.rhtml' %>
+<%= render '_sidebar_toggle.rhtml' %>
-  <%= render '_sidebar_search.rhtml' %>
-  <div id="project-metadata">
-    <%= render '_sidebar_pages.rhtml' %>
-    <%= render '_sidebar_classes.rhtml' %>
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
   </div>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">
@@ -15,4 +18,3 @@
   <p><%= message %>
 </main>

data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml CHANGED Viewed

@@ -1,5 +1,7 @@
 <body role="document">
-<nav role="navigation">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
   <div id="project-navigation">
     <div id="home-section" class="nav-section">
       <h2>
@@ -10,7 +12,8 @@
     <%= render '_sidebar_search.rhtml' %>
   </div>
-<%= render '_sidebar_installed.rhtml' %>
+  <%= render '_sidebar_installed.rhtml' %>
+  <%= render '_footer.rhtml' %>
 </nav>
 <main role="main">

data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml CHANGED Viewed

@@ -1,4 +1,15 @@
 <body id="top" class="table-of-contents">
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="navigation" role="navigation">
+  <div id="project-navigation">
+    <%= render '_sidebar_navigation.rhtml' %>
+    <%= render '_sidebar_search.rhtml' %>
+  </div>
+  <%= render '_footer.rhtml' %>
+</nav>
 <main role="main">
 <h1 class="class"><%= h @title %></h1>

data/lib/rdoc/markdown.kpeg CHANGED Viewed

@@ -530,7 +530,7 @@ AtxInline = !@Newline !(@Sp /#*/ @Sp @Newline) Inline
 AtxStart =  < /\#{1,6}/ >
             { text.length }
-AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
+AtxHeading = AtxStart:s @Spacechar+ AtxInline+:a (@Sp /#*/ @Sp)?  @Newline
             { RDoc::Markup::Heading.new(s, a.join) }
 SetextHeading = SetextHeading1 | SetextHeading2

data/lib/rdoc/markdown.rb CHANGED Viewed

@@ -1158,7 +1158,7 @@ class RDoc::Markdown
     return _tmp
   end
-  # AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }
+  # AtxHeading = AtxStart:s @Spacechar+ AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }
   def _AtxHeading
     _save = self.pos
@@ -1169,12 +1169,22 @@ class RDoc::Markdown
         self.pos = _save
         break
       end
-      _tmp = _Sp()
+      _save1 = self.pos
+      _tmp = _Spacechar()
+      if _tmp
+        while true
+          _tmp = _Spacechar()
+          break unless _tmp
+        end
+        _tmp = true
+      else
+        self.pos = _save1
+      end
       unless _tmp
         self.pos = _save
         break
       end
-      _save1 = self.pos
+      _save2 = self.pos
       _ary = []
       _tmp = apply(:_AtxInline)
       if _tmp
@@ -1187,37 +1197,37 @@ class RDoc::Markdown
         _tmp = true
         @result = _ary
       else
-        self.pos = _save1
+        self.pos = _save2
       end
       a = @result
       unless _tmp
         self.pos = _save
         break
       end
-      _save2 = self.pos
       _save3 = self.pos
+      _save4 = self.pos
       while true # sequence
         _tmp = _Sp()
         unless _tmp
-          self.pos = _save3
+          self.pos = _save4
           break
         end
         _tmp = scan(/\G(?-mix:#*)/)
         unless _tmp
-          self.pos = _save3
+          self.pos = _save4
           break
         end
         _tmp = _Sp()
         unless _tmp
-          self.pos = _save3
+          self.pos = _save4
         end
         break
       end # end sequence
       unless _tmp
         _tmp = true
-        self.pos = _save2
+        self.pos = _save3
       end
       unless _tmp
         self.pos = _save
@@ -16539,7 +16549,7 @@ class RDoc::Markdown
   Rules[:_Plain] = rule_info("Plain", "Inlines:a { paragraph a }")
   Rules[:_AtxInline] = rule_info("AtxInline", "!@Newline !(@Sp /\#*/ @Sp @Newline) Inline")
   Rules[:_AtxStart] = rule_info("AtxStart", "< /\\\#{1,6}/ > { text.length }")
-  Rules[:_AtxHeading] = rule_info("AtxHeading", "AtxStart:s @Sp AtxInline+:a (@Sp /\#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }")
+  Rules[:_AtxHeading] = rule_info("AtxHeading", "AtxStart:s @Spacechar+ AtxInline+:a (@Sp /\#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }")
   Rules[:_SetextHeading] = rule_info("SetextHeading", "(SetextHeading1 | SetextHeading2)")
   Rules[:_SetextBottom1] = rule_info("SetextBottom1", "/={1,}/ @Newline")
   Rules[:_SetextBottom2] = rule_info("SetextBottom2", "/-{1,}/ @Newline")

data/lib/rdoc/markup/attribute_manager.rb CHANGED Viewed

@@ -260,7 +260,7 @@ class RDoc::Markup::AttributeManager
   def add_word_pair(start, stop, name, exclusive = false)
     raise ArgumentError, "Word flags may not start with '<'" if
-      start[0,1] == '<'
+      start[0, 1] == '<'
     bitmap = @attributes.bitmap_for name
@@ -271,7 +271,7 @@ class RDoc::Markup::AttributeManager
       @word_pair_map[pattern] = bitmap
     end
-    @protectable << start[0,1]
+    @protectable << start[0, 1]
     @protectable.uniq!
     @exclusive_bitmap |= bitmap if exclusive

data/lib/rdoc/markup/formatter.rb CHANGED Viewed

@@ -195,18 +195,20 @@ class RDoc::Markup::Formatter
     @in_tt > 0
   end
+  def tt_tag? attr_mask, reverse = false
+    each_attr_tag(attr_mask, reverse) do |tag|
+      return true if tt? tag
+    end
+    false
+  end
   ##
   # Turns on tags for +item+ on +res+
   def on_tags res, item
-    attr_mask = item.turn_on
-    return if attr_mask.zero?
-    @attr_tags.each do |tag|
-      if attr_mask & tag.bit != 0 then
-        res << annotate(tag.on)
-        @in_tt += 1 if tt? tag
-      end
+    each_attr_tag(item.turn_on) do |tag|
+      res << annotate(tag.on)
+      @in_tt += 1 if tt? tag
     end
   end
@@ -214,13 +216,18 @@ class RDoc::Markup::Formatter
   # Turns off tags for +item+ on +res+
   def off_tags res, item
-    attr_mask = item.turn_off
+    each_attr_tag(item.turn_off, true) do |tag|
+      @in_tt -= 1 if tt? tag
+      res << annotate(tag.off)
+    end
+  end
+  def each_attr_tag attr_mask, reverse = false
     return if attr_mask.zero?
-    @attr_tags.reverse_each do |tag|
+    @attr_tags.public_send(reverse ? :reverse_each : :each) do |tag|
       if attr_mask & tag.bit != 0 then
-        @in_tt -= 1 if tt? tag
-        res << annotate(tag.off)
+        yield tag
       end
     end
   end

data/lib/rdoc/markup/pre_process.rb CHANGED Viewed

@@ -97,15 +97,18 @@ class RDoc::Markup::PreProcess
   # RDoc::CodeObject#metadata for details.
   def handle text, code_object = nil, &block
+    first_line = 1
     if RDoc::Comment === text then
       comment = text
       text = text.text
+      first_line = comment.line || 1
     end
     # regexp helper (square brackets for optional)
     # $1      $2  $3        $4      $5
     # [prefix][\]:directive:[spaces][param]newline
-    text = text.gsub(/^([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):(\w+):([ \t]*)(.+)?(\r?\n|$)/) do
+    text = text.lines.map.with_index(first_line) do |line, num|
+      next line unless line =~ /\A([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):([\w-]+):([ \t]*)(.+)?(\r?\n|$)/
       # skip something like ':toto::'
       next $& if $4.empty? and $5 and $5[0, 1] == ':'
@@ -120,8 +123,8 @@ class RDoc::Markup::PreProcess
         next "#{$1.strip}\n"
       end
-      handle_directive $1, $3, $5, code_object, text.encoding, &block
-    end
+      handle_directive $1, $3, $5, code_object, text.encoding, num, &block
+    end.join
     if comment then
       comment.text = text
@@ -148,7 +151,7 @@ class RDoc::Markup::PreProcess
   # When 1.8.7 support is ditched prefix can be defaulted to ''
   def handle_directive prefix, directive, param, code_object = nil,
-                       encoding = nil
+                       encoding = nil, line = nil
     blankline = "#{prefix.strip}\n"
     directive = directive.downcase
@@ -184,6 +187,14 @@ class RDoc::Markup::PreProcess
       include_file filename, prefix, encoding
     when 'main' then
       @options.main_page = param if @options.respond_to? :main_page
+      warn <<~MSG
+        The :main: directive is deprecated and will be removed in RDoc 7.
+        You can use these options to specify the initial page displayed instead:
+        - `--main=#{param}` via the command line
+        - `rdoc.main = "#{param}"` if you use `RDoc::Task`
+        - `main_page: #{param}` in your `.rdoc_options` file
+      MSG
       blankline
     when 'nodoc' then
@@ -214,17 +225,26 @@ class RDoc::Markup::PreProcess
     when 'title' then
       @options.default_title = param if @options.respond_to? :default_title=
+      warn <<~MSG
+        The :title: directive is deprecated and will be removed in RDoc 7.
+        You can use these options to specify the title displayed instead:
+        - `--title=#{param}` via the command line
+        - `rdoc.title = "#{param}"` if you use `RDoc::Task`
+        - `title: #{param}` in your `.rdoc_options` file
+      MSG
       blankline
     when 'yield', 'yields' then
       return blankline unless code_object
       # remove parameter &block
       code_object.params = code_object.params.sub(/,?\s*&\w+/, '') if code_object.params
-      code_object.block_params = param
+      code_object.block_params = param || ''
       blankline
     else
-      result = yield directive, param if block_given?
+      result = yield directive, param, line if block_given?
       case result
       when nil then

data/lib/rdoc/markup/to_bs.rb CHANGED Viewed

@@ -24,7 +24,7 @@ class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
   def init_tags
     add_tag :BOLD, '+b', '-b'
     add_tag :EM,   '+_', '-_'
-    add_tag :TT,   ''  , ''   # we need in_tt information maintained
+    add_tag :TT,   '', ''   # we need in_tt information maintained
   end
   ##

data/lib/rdoc/markup/to_html.rb CHANGED Viewed

@@ -407,7 +407,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
       "<li>"
     when :LABEL, :NOTE then
       Array(list_item.label).map do |label|
-        "<dt>#{to_html label}\n"
+        "<dt>#{to_html label}</dt>\n"
       end.join << "<dd>"
     else
       raise RDoc::Error, "Invalid list type: #{list_type.inspect}"

data/lib/rdoc/markup/to_html_crossref.rb CHANGED Viewed

@@ -58,7 +58,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # Creates a link to the reference +name+ if the name exists.  If +text+ is
   # given it is used as the link text, otherwise +name+ is used.
-  def cross_reference name, text = nil, code = true
+  def cross_reference name, text = nil, code = true, rdoc_ref: false
     lookup = name
     name = name[1..-1] unless @show_hash if name[0, 1] == '#'
@@ -70,7 +70,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       text ||= name
     end
-    link lookup, text, code
+    link lookup, text, code, rdoc_ref: rdoc_ref
   end
   ##
@@ -83,6 +83,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   def handle_regexp_CROSSREF(target)
     name = target.text
+    return name if @options.autolink_excluded_words&.include?(name)
     return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
     unless @hyperlink_all then
@@ -92,7 +94,7 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
       return name if name =~ /\A[a-z]*\z/
     end
-    cross_reference name
+    cross_reference name, rdoc_ref: false
   end
   ##
@@ -100,9 +102,14 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # handle other schemes.
   def handle_regexp_HYPERLINK target
-    return cross_reference $' if target.text =~ /\Ardoc-ref:/
+    url = target.text
-    super
+    case url
+    when /\Ardoc-ref:/
+      cross_reference $', rdoc_ref: true
+    else
+      super
+    end
   end
   ##
@@ -117,8 +124,8 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     url = target.text
     case url
-    when /\Ardoc-ref:/ then
-      cross_reference $'
+    when /\Ardoc-ref:/
+      cross_reference $', rdoc_ref: true
     else
       super
     end
@@ -129,16 +136,18 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
   # RDoc::Markup::ToHtml to handle other schemes.
   def gen_url url, text
-    return super unless url =~ /\Ardoc-ref:/
-    name = $'
-    cross_reference name, text, name == text
+    if url =~ /\Ardoc-ref:/
+      name = $'
+      cross_reference name, text, name == text, rdoc_ref: true
+    else
+      super
+    end
   end
   ##
   # Creates an HTML link to +name+ with the given +text+.
-  def link name, text, code = true
+  def link name, text, code = true, rdoc_ref: false
     if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])?@/
       name = $1
       label = $'
@@ -148,6 +157,9 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     case ref
     when String then
+      if rdoc_ref && @options.warn_missing_rdoc_ref
+        puts "#{@from_path}: `rdoc-ref:#{name}` can't be resolved for `#{text}`"
+      end
       ref
     else
       path = ref ? ref.as_href(@from_path) : +""
@@ -172,4 +184,43 @@ class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
     end
   end
+  def convert_flow(flow)
+    res = []
+    i = 0
+    while i < flow.size
+      item = flow[i]
+      i += 1
+      case item
+      when RDoc::Markup::AttrChanger then
+        # Make "+Class#method+" a cross reference
+        if tt_tag?(item.turn_on) and
+          String === (str = flow[i]) and
+          RDoc::Markup::AttrChanger === flow[i+1] and
+          tt_tag?(flow[i+1].turn_off, true) and
+          (@options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP).match?(str) and
+          (text = cross_reference str) != str
+        then
+          text = yield text, res if defined?(yield)
+          res << text
+          i += 2
+          next
+        end
+        off_tags res, item
+        on_tags res, item
+      when String then
+        text = convert_string(item)
+        text = yield text, res if defined?(yield)
+        res << text
+      when RDoc::Markup::RegexpHandling then
+        text = convert_regexp_handling(item)
+        text = yield text, res if defined?(yield)
+        res << text
+      else
+        raise "Unknown flow element: #{item.inspect}"
+      end
+    end
+    res.join('')
+  end
 end

data/lib/rdoc/markup/to_rdoc.rb CHANGED Viewed

@@ -249,12 +249,12 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
   # Adds +table+ to the output
   def accept_table header, body, aligns
-    widths = header.zip(body) do |h, b|
-      [h.size, b.size].max
+    widths = header.zip(*body).map do |cols|
+      cols.map(&:size).max
     end
     aligns = aligns.map do |a|
       case a
-      when nil
+      when nil, :center
         :center
       when :left
         :ljust
@@ -262,12 +262,12 @@ class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
         :rjust
       end
     end
-    @res << header.zip(widths, aligns) do |h, w, a|
+    @res << header.zip(widths, aligns).map do |h, w, a|
       h.__send__(a, w)
     end.join("|").rstrip << "\n"
     @res << widths.map {|w| "-" * w }.join("|") << "\n"
     body.each do |row|
-      @res << row.zip(widths, aligns) do |t, w, a|
+      @res << row.zip(widths, aligns).map do |t, w, a|
         t.__send__(a, w)
       end.join("|").rstrip << "\n"
     end

data/lib/rdoc/markup.rb CHANGED Viewed

@@ -10,19 +10,24 @@
 # RDoc::Markup and other markup formats do no output formatting, this is
 # handled by the RDoc::Markup::Formatter subclasses.
 #
-# = Supported Formats
-#
-# Besides the RDoc::Markup format, the following formats are built in to RDoc:
-#
-# markdown::
-#   The markdown format as described by
-#   http://daringfireball.net/projects/markdown/.  See RDoc::Markdown for
-#   details on the parser and supported extensions.
-# rd::
-#   The rdtool format.  See RDoc::RD for details on the parser and format.
-# tomdoc::
-#   The TomDoc format as described by http://tomdoc.org/.  See RDoc::TomDoc
-#   for details on the parser and supported extensions.
+# = Markup Formats
+#
+# +RDoc+ supports these markup formats:
+#
+# - +rdoc+:
+#   the +RDoc+ markup format;
+#   see RDoc::MarkupReference.
+# - +markdown+:
+#   The +markdown+ markup format as described in
+#   the {Markdown Guide}[https://www.markdownguide.org];
+#   see RDoc::Markdown.
+# - +rd+:
+#   the +rd+ markup format format;
+#   see RDoc::RD.
+# - +tomdoc+:
+#   the TomDoc format as described in
+#   {TomDoc for Ruby}[http://tomdoc.org];
+#   see RDoc::TomDoc.
 #
 # You can choose a markup format using the following methods:
 #