RubyGems - rdoc - Versions diffs - 6.3.4.1 → 8.0.0 - Mend

rdoc 6.3.4.1 → 8.0.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 (205) hide show

checksums.yaml +4 -4
data/CONTRIBUTING.md +195 -0
data/History.rdoc +65 -63
data/LEGAL.rdoc +7 -1
data/LICENSE.rdoc +6 -0
data/README.md +236 -0
data/RI.md +842 -0
data/TODO.rdoc +8 -7
data/doc/markup_reference/markdown.md +659 -0
data/doc/markup_reference/rdoc.rdoc +1169 -0
data/exe/rdoc +0 -1
data/lib/rdoc/{alias.rb → code_object/alias.rb} +4 -18
data/lib/rdoc/{any_method.rb → code_object/any_method.rb} +50 -24
data/lib/rdoc/{attr.rb → code_object/attr.rb} +16 -14
data/lib/rdoc/{class_module.rb → code_object/class_module.rb} +225 -58
data/lib/rdoc/{constant.rb → code_object/constant.rb} +44 -10
data/lib/rdoc/code_object/context/section.rb +182 -0
data/lib/rdoc/{context.rb → code_object/context.rb} +78 -106
data/lib/rdoc/{extend.rb → code_object/extend.rb} +0 -1
data/lib/rdoc/{include.rb → code_object/include.rb} +0 -1
data/lib/rdoc/{method_attr.rb → code_object/method_attr.rb} +46 -48
data/lib/rdoc/{mixin.rb → code_object/mixin.rb} +6 -4
data/lib/rdoc/{normal_class.rb → code_object/normal_class.rb} +2 -3
data/lib/rdoc/{normal_module.rb → code_object/normal_module.rb} +2 -3
data/lib/rdoc/{require.rb → code_object/require.rb} +1 -2
data/lib/rdoc/{single_class.rb → code_object/single_class.rb} +5 -1
data/lib/rdoc/{top_level.rb → code_object/top_level.rb} +60 -63
data/lib/rdoc/code_object.rb +11 -39
data/lib/rdoc/code_objects.rb +1 -2
data/lib/rdoc/comment.rb +202 -99
data/lib/rdoc/cross_reference.rb +75 -62
data/lib/rdoc/encoding.rb +8 -24
data/lib/rdoc/erb_partial.rb +1 -2
data/lib/rdoc/erbio.rb +3 -8
data/lib/rdoc/generator/aliki.rb +200 -0
data/lib/rdoc/generator/darkfish.rb +156 -122
data/lib/rdoc/generator/json_index.rb +8 -24
data/lib/rdoc/generator/markup.rb +70 -34
data/lib/rdoc/generator/pot/message_extractor.rb +7 -7
data/lib/rdoc/generator/pot/po.rb +1 -1
data/lib/rdoc/generator/pot/po_entry.rb +8 -8
data/lib/rdoc/generator/pot.rb +1 -5
data/lib/rdoc/generator/ri.rb +1 -2
data/lib/rdoc/generator/template/aliki/DESIGN.md +536 -0
data/lib/rdoc/generator/template/aliki/_aside_toc.rhtml +8 -0
data/lib/rdoc/generator/template/aliki/_footer.rhtml +23 -0
data/lib/rdoc/generator/template/aliki/_head.rhtml +163 -0
data/lib/rdoc/generator/template/aliki/_header.rhtml +56 -0
data/lib/rdoc/generator/template/aliki/_icons.rhtml +208 -0
data/lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml +16 -0
data/lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml +15 -0
data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +27 -0
data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +27 -0
data/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml +16 -0
data/lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml +41 -0
data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +67 -0
data/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +15 -0
data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +21 -0
data/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml +3 -0
data/lib/rdoc/generator/template/aliki/class.rhtml +230 -0
data/lib/rdoc/generator/template/aliki/css/rdoc.css +2181 -0
data/lib/rdoc/generator/template/aliki/index.rhtml +22 -0
data/lib/rdoc/generator/template/aliki/js/aliki.js +513 -0
data/lib/rdoc/generator/template/aliki/js/bash_highlighter.js +167 -0
data/lib/rdoc/generator/template/aliki/js/c_highlighter.js +299 -0
data/lib/rdoc/generator/template/aliki/js/search_controller.js +129 -0
data/lib/rdoc/generator/template/aliki/js/search_navigation.js +105 -0
data/lib/rdoc/generator/template/aliki/js/search_ranker.js +239 -0
data/lib/rdoc/generator/template/aliki/js/theme-toggle.js +112 -0
data/lib/rdoc/generator/template/aliki/page.rhtml +18 -0
data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +14 -0
data/lib/rdoc/generator/template/aliki/servlet_root.rhtml +65 -0
data/lib/rdoc/generator/template/darkfish/_footer.rhtml +3 -3
data/lib/rdoc/generator/template/darkfish/_head.rhtml +35 -14
data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +1 -5
data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +11 -9
data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +11 -9
data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +7 -6
data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +20 -11
data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +25 -5
data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +4 -9
data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +2 -1
data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +28 -7
data/lib/rdoc/generator/template/darkfish/_sidebar_toggle.rhtml +3 -0
data/lib/rdoc/generator/template/darkfish/class.rhtml +138 -90
data/lib/rdoc/generator/template/darkfish/css/rdoc.css +420 -358
data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf +0 -0
data/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf +0 -0
data/lib/rdoc/generator/template/darkfish/index.rhtml +14 -12
data/lib/rdoc/generator/template/darkfish/js/darkfish.js +59 -3
data/lib/rdoc/generator/template/darkfish/js/search.js +15 -5
data/lib/rdoc/generator/template/darkfish/page.rhtml +7 -6
data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +12 -9
data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +24 -21
data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +35 -21
data/lib/rdoc/generator/template/json_index/js/navigation.js +8 -8
data/lib/rdoc/generator/template/json_index/js/searcher.js +48 -6
data/lib/rdoc/generator.rb +6 -5
data/lib/rdoc/i18n/text.rb +3 -3
data/lib/rdoc/i18n.rb +1 -1
data/lib/rdoc/known_classes.rb +5 -4
data/lib/rdoc/markdown/entities.rb +0 -1
data/lib/rdoc/markdown/literals.kpeg +0 -2
data/lib/rdoc/markdown/literals.rb +0 -1
data/lib/rdoc/markdown.kpeg +140 -62
data/lib/rdoc/markdown.rb +1015 -873
data/lib/rdoc/markup/blank_line.rb +25 -24
data/lib/rdoc/markup/block_quote.rb +1 -2
data/lib/rdoc/markup/document.rb +10 -11
data/lib/rdoc/markup/element.rb +21 -0
data/lib/rdoc/markup/formatter.rb +134 -115
data/lib/rdoc/markup/hard_break.rb +30 -28
data/lib/rdoc/markup/heading.rb +163 -72
data/lib/rdoc/markup/include.rb +3 -4
data/lib/rdoc/markup/indented_paragraph.rb +4 -5
data/lib/rdoc/markup/inline_parser.rb +312 -0
data/lib/rdoc/markup/list.rb +6 -7
data/lib/rdoc/markup/list_item.rb +6 -7
data/lib/rdoc/markup/paragraph.rb +2 -3
data/lib/rdoc/markup/parser.rb +29 -19
data/lib/rdoc/markup/pre_process.rb +39 -18
data/lib/rdoc/markup/raw.rb +52 -56
data/lib/rdoc/markup/rule.rb +2 -3
data/lib/rdoc/markup/table.rb +49 -32
data/lib/rdoc/markup/to_ansi.rb +58 -8
data/lib/rdoc/markup/to_bs.rb +47 -38
data/lib/rdoc/markup/to_html.rb +343 -105
data/lib/rdoc/markup/to_html_crossref.rb +143 -58
data/lib/rdoc/markup/to_html_snippet.rb +78 -76
data/lib/rdoc/markup/to_joined_paragraph.rb +3 -9
data/lib/rdoc/markup/to_label.rb +34 -25
data/lib/rdoc/markup/to_markdown.rb +74 -51
data/lib/rdoc/markup/to_rdoc.rb +141 -82
data/lib/rdoc/markup/to_table_of_contents.rb +4 -5
data/lib/rdoc/markup/to_test.rb +10 -3
data/lib/rdoc/markup/to_tt_only.rb +17 -31
data/lib/rdoc/markup/verbatim.rb +5 -6
data/lib/rdoc/markup.rb +59 -707
data/lib/rdoc/options.rb +228 -101
data/lib/rdoc/parser/c.rb +186 -184
data/lib/rdoc/parser/changelog.rb +57 -13
data/lib/rdoc/parser/markdown.rb +0 -2
data/lib/rdoc/parser/rbs.rb +275 -0
data/lib/rdoc/parser/rd.rb +0 -1
data/lib/rdoc/parser/ruby.rb +963 -2024
data/lib/rdoc/parser/ruby_colorizer.rb +253 -0
data/lib/rdoc/parser/simple.rb +6 -23
data/lib/rdoc/parser/text.rb +0 -1
data/lib/rdoc/parser.rb +35 -14
data/lib/rdoc/rbs_helper.rb +186 -0
data/lib/rdoc/rd/block_parser.rb +659 -11
data/lib/rdoc/rd/block_parser.ry +13 -9
data/lib/rdoc/rd/inline.rb +4 -5
data/lib/rdoc/rd/inline_parser.rb +646 -2
data/lib/rdoc/rd.rb +4 -5
data/lib/rdoc/rdoc.rb +234 -90
data/lib/rdoc/ri/driver.rb +172 -172
data/lib/rdoc/ri/paths.rb +3 -3
data/lib/rdoc/{servlet.rb → ri/servlet.rb} +28 -27
data/lib/rdoc/ri/store.rb +0 -1
data/lib/rdoc/ri/task.rb +3 -3
data/lib/rdoc/ri.rb +5 -5
data/lib/rdoc/rubygems_hook.rb +106 -25
data/lib/rdoc/server.rb +460 -0
data/lib/rdoc/stats/normal.rb +1 -1
data/lib/rdoc/stats/quiet.rb +1 -2
data/lib/rdoc/stats/verbose.rb +3 -5
data/lib/rdoc/stats.rb +158 -136
data/lib/rdoc/store.rb +267 -48
data/lib/rdoc/task.rb +54 -28
data/lib/rdoc/text.rb +60 -120
data/lib/rdoc/token_stream.rb +30 -45
data/lib/rdoc/tom_doc.rb +9 -15
data/lib/rdoc/version.rb +3 -1
data/lib/rdoc.rb +90 -52
data/lib/rubygems_plugin.rb +14 -0
data/man/ri.1 +2 -0
data/rdoc-logo.svg +43 -0
data/rdoc.gemspec +25 -200
metadata +120 -53
data/CONTRIBUTING.rdoc +0 -220
data/ExampleMarkdown.md +0 -37
data/ExampleRDoc.rdoc +0 -208
data/Gemfile +0 -12
data/README.rdoc +0 -129
data/RI.rdoc +0 -57
data/Rakefile +0 -101
data/bin/console +0 -7
data/bin/setup +0 -6
data/lib/rdoc/anon_class.rb +0 -11
data/lib/rdoc/context/section.rb +0 -232
data/lib/rdoc/generator/template/darkfish/.document +0 -0
data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +0 -19
data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +0 -9
data/lib/rdoc/generator/template/json_index/.document +0 -1
data/lib/rdoc/ghost_method.rb +0 -7
data/lib/rdoc/markup/attr_changer.rb +0 -23
data/lib/rdoc/markup/attr_span.rb +0 -36
data/lib/rdoc/markup/attribute_manager.rb +0 -409
data/lib/rdoc/markup/attributes.rb +0 -71
data/lib/rdoc/markup/regexp_handling.rb +0 -41
data/lib/rdoc/meta_method.rb +0 -7
data/lib/rdoc/parser/ripper_state_lex.rb +0 -590
data/lib/rdoc/parser/ruby_tools.rb +0 -167

data/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml ADDED Viewed

@@ -0,0 +1,3 @@
+<div id="sidebar-navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="false" aria-controls="sidebar-navigation">
+  <span aria-hidden="true">&#9776;</span>
+</div>

data/lib/rdoc/generator/template/aliki/class.rhtml ADDED Viewed

@@ -0,0 +1,230 @@
+<body role="document" class="<%= klass.type %> has-toc">
+<%= render '_icons.rhtml' %>
+<%= render '_header.rhtml' %>
+<%= render '_sidebar_toggle.rhtml' %>
+<nav id="sidebar-navigation" role="navigation" hidden>
+  <%= render '_sidebar_pages.rhtml' %>
+  <%= render '_sidebar_sections.rhtml' %>
+  <%= render '_sidebar_ancestors.rhtml' %>
+  <%= render '_sidebar_includes.rhtml' %>
+  <%= render '_sidebar_extends.rhtml' %>
+  <%= render '_sidebar_methods.rhtml' %>
+  <%= render '_sidebar_classes.rhtml' %>
+</nav>
+<main role="main" aria-labelledby="<%= h klass.aref %>">
+  <%# If nesting level is 1, breadcrumb list is not needed %>
+  <% if breadcrumb.size > 1 %>
+    <ol role="navigation" aria-label="Breadcrumb navigation" class="breadcrumb">
+      <% breadcrumb.each do |namespace| %>
+      <li>
+        <% if namespace[:self] %>
+        <span><%= namespace[:name] %></span>
+        <% else %>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span class="separator">::</span>
+        <% end %>
+      </li>
+      <% end %>
+    </ol>
+  <% end %>
+  <span id="<%= h klass.legacy_aref %>" class="legacy-anchor"></span>
+  <h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %> page-title">
+    <span class="page-title-kind"><%= klass.type %></span>
+    <span class="page-title-name"><%= klass.full_name %></span>
+  </h1>
+  <section class="description">
+    <%= klass.description %>
+  </section>
+  <%- klass.each_section do |section, constants, attributes| %>
+  <span id="<%= section.legacy_aref %>" class="legacy-anchor"></span>
+  <section class="documentation-section anchor-link">
+    <%- if section.title %>
+    <header class="documentation-section-title">
+      <h2 id="<%= section.aref %>">
+        <a href="#<%= section.aref %>"><%= section.title %></a>
+      </h2>
+    </header>
+    <%- end %>
+    <%- if section.comment %>
+    <div>
+      <%= section.description %>
+    </div>
+    <%- end %>
+    <%- unless constants.empty? %>
+    <section class="constants-list">
+      <header>
+        <h3 id="<%= section.aref %>-constants"><a href="#<%= section.aref %>-constants">Constants</a></h3>
+      </header>
+      <dl>
+      <%- constants.each do |const| %>
+        <dt id="<%= const.name %>"><%= const.name %></dt>
+        <%- if const.comment %>
+        <dd>
+          <%- if const.mixin_from %>
+            <div class="mixin-from">
+              Included from <a href="<%= klass.aref_to(const.mixin_from.path) %>"><%= const.mixin_from.full_name %></a>
+            </div>
+          <%- end %>
+          <%= const.description.strip %>
+        </dd>
+        <%- else %>
+        <dd class="missing-docs">(Not documented)</dd>
+        <%- end %>
+      <%- end %>
+      </dl>
+    </section>
+    <%- end %>
+    <%- unless attributes.empty? %>
+    <section class="attribute-method-details method-section">
+      <header>
+        <h3 id="<%= section.aref %>-attributes"><a href="#<%= section.aref %>-attributes">Attributes</a></h3>
+      </header>
+      <%- attributes.each do |attrib| %>
+      <div id="<%= attrib.aref %>" class="method-detail anchor-link">
+        <div class="method-heading attribute-method-heading">
+          <a href="#<%= attrib.aref %>" title="Link to this attribute">
+            <span class="method-name"><%= h attrib.name %></span>
+            <span class="attribute-access-type">[<%= attrib.rw %>]</span>
+          </a>
+          <%- if (sig_html = type_signature_html(attrib, klass.path)) %>
+          <span class="method-type-signature"><code><%= sig_html %></code></span>
+          <%- end %>
+        </div>
+        <div class="method-description">
+        <%- if attrib.mixin_from %>
+          <div class="mixin-from">
+            <%= attrib.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(attrib.mixin_from.path) %>"><%= attrib.mixin_from.full_name %></a>
+          </div>
+        <%- end %>
+        <%- if attrib.comment %>
+        <%= attrib.description.strip %>
+        <%- else %>
+        <p class="missing-docs">(Not documented)</p>
+        <%- end %>
+        </div>
+      </div>
+      <%- end %>
+    </section>
+    <%- end %>
+    <%- klass.methods_by_type(section).each do |type, visibilities| %>
+    <%- next if visibilities.empty? %>
+    <%- visibilities.each do |visibility, methods| %>
+    <%- next if methods.empty? %>
+     <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section anchor-link">
+       <header>
+         <h3 id="<%= visibility %>-<%= type %>-<%= section.aref %>-methods"><a href="#<%= visibility %>-<%= type %>-<%= section.aref %>-methods"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</a></h3>
+       </header>
+    <%- methods.each do |method| %>
+      <div id="<%= method.aref %>" class="method-detail anchor-link <%= method.is_alias_for ? "method-alias" : '' %>">
+        <div class="method-header">
+          <div class="method-heading-group">
+            <%- if (call_seq = method.call_seq) %>
+              <%- call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+                <div class="method-heading">
+                  <a href="#<%= method.aref %>" title="Link to this method">
+                    <span class="method-callseq">
+                      <%= h(call_seq.strip.
+                          gsub( /^\w+\./m, '')).
+                          gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+                    </span>
+                  </a>
+                </div>
+              <%- end %>
+            <%- elsif method.has_call_seq? %>
+              <div class="method-heading">
+                <a href="#<%= method.aref %>" title="Link to this method">
+                  <span class="method-name"><%= h method.name %></span>
+                </a>
+              </div>
+            <%- else %>
+              <div class="method-heading">
+                <a href="#<%= method.aref %>" title="Link to this method">
+                  <span class="method-name"><%= h method.name %></span>
+                  <span class="method-args"><%= h method.param_seq %></span>
+                </a>
+              </div>
+            <%- end %>
+            <%- if (sig_html = type_signature_html(method, klass.path)) %>
+            <pre class="method-type-signature"><code><%= sig_html %></code></pre>
+            <%- end %>
+          </div>
+          <%- if method.token_stream %>
+            <div class="method-controls">
+              <details class="method-source-toggle">
+                <summary><span class="method-source-icon" aria-hidden="true">{}</span> Source</summary>
+              </details>
+            </div>
+          <%- end %>
+        </div>
+        <%- if method.token_stream %>
+          <div class="method-source-code" id="<%= method.html_name %>-source">
+            <pre class="<%= method.source_language %>"><%= method.markup_code %></pre>
+          </div>
+        <%- end %>
+        <%- unless method.skip_description? %>
+        <div class="method-description">
+          <%- if method.mixin_from %>
+            <div class="mixin-from">
+              <%= method.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(method.mixin_from.path) %>"><%= method.mixin_from.full_name %></a>
+            </div>
+          <%- end %>
+          <%- if method.comment %>
+          <%= method.description.strip %>
+          <%- else %>
+          <p class="missing-docs">(Not documented)</p>
+          <%- end %>
+          <%- if method.calls_super %>
+            <div class="method-calls-super">
+              Calls superclass method
+              <%= method.superclass_method_link %>
+            </div>
+          <%- end %>
+        </div>
+        <%- end %>
+        <%- unless method.aliases.empty? %>
+        <div class="aliases">
+          Also aliased as: <%= method.aliases.map do |aka|
+            if aka.parent then # HACK lib/rexml/encodings
+              %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
+            else
+              h aka.name
+            end
+          end.join ", " %>
+        </div>
+        <%- end %>
+        <%- if method.is_alias_for %>
+        <div class="aliases">
+          Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+        </div>
+        <%- end %>
+      </div>
+    <%- end %>
+    </section>
+  <%- end %>
+  <%- end %>
+  </section>
+<%- end %>
+</main>
+<%= render '_aside_toc.rhtml' %>
+<%= render '_footer.rhtml' %>
+</body>