rdoc 7.1.0 → 8.0.0

data/lib/rdoc/generator/template/aliki/_head.rhtml

@@ -28,7 +28,7 @@
 <%- elsif @title %>
   <meta name="keywords" content="ruby,documentation,<%= h @title %>">
   <%- if @options.main_page and
-      main_page = @files.find { |f| f.full_name == @options.main_page } then %>
+      main_page = @files.find { |f| f.full_name == @options.main_page } %>
     <meta
       name="description"
       content="<%= h "#{@title}: #{excerpt(main_page.comment)}" %>"
@@ -140,6 +140,11 @@
   defer
 ></script>
 
+<script
+  src="<%= h asset_rel_prefix %>/js/bash_highlighter.js?v=<%= h RDoc::VERSION %>"
+  defer
+></script>
+
 <script
   src="<%= h asset_rel_prefix %>/js/aliki.js?v=<%= h RDoc::VERSION %>"
   defer

data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml

@@ -1,4 +1,4 @@
-<%- unless klass.extends.empty? then %>
+<%- unless klass.extends.empty? %>
 <div id="extends-section" class="nav-section">
   <details class="nav-section-collapsible" open>
     <summary class="nav-section-header">
@@ -13,11 +13,13 @@
 
     <ul class="nav-list">
       <%- klass.extends.each do |ext| %>
-    <%- unless String === ext.module then %>
-      <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a></li>
-    <%- else %>
-      <li><span class="extend"><%= ext.name %></span></li>
-    <%- end %>
+      <li>
+      <%- unless String === ext.module %>
+        <a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
+      <%- else %>
+        <span class="extend"><%= ext.name %></span>
+      <%- end %>
+      </li>
     <%- end %>
     </ul>
   </details>

data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml

@@ -1,4 +1,4 @@
-<%- unless klass.includes.empty? then %>
+<%- unless klass.includes.empty? %>
 <div id="includes-section" class="nav-section">
   <details class="nav-section-collapsible" open>
     <summary class="nav-section-header">
@@ -13,11 +13,13 @@
 
     <ul class="nav-list">
     <%- klass.includes.each do |inc| %>
-    <%- unless String === inc.module then %>
-      <li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
-    <%- else %>
-      <li><span class="include"><%= inc.name %></span></li>
-    <%- end %>
+      <li>
+      <%- unless String === inc.module %>
+        <a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
+      <%- else %>
+        <span class="include"><%= inc.name %></span>
+      <%- end %>
+      </li>
     <%- end %>
     </ul>
   </details>

data/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml

@@ -5,7 +5,7 @@
   <%- installed.each do |name, href, exists, type, _| %>
     <%- next if type == :extra %>
     <li class="folder">
-    <%- if exists then %>
+    <%- if exists %>
       <a href="<%= href %>"><%= h name %></a>
     <%- else %>
       <%= h name %>

data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml

@@ -1,10 +1,10 @@
-<%- simple_files = @files.select { |f| f.text? } %>
+<%- simple_files = @files.select { |f| f.text? && f.full_name != @options.main_page } %>
 
 <%- if defined?(current) && current.respond_to?(:page_name) %>
   <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
 <%- end %>
 
-<%- unless simple_files.empty? then %>
+<%- unless simple_files.empty? %>
   <div id="fileindex-section" class="nav-section">
     <details class="nav-section-collapsible" <%= 'open' unless @inside_class_file %>>
       <summary class="nav-section-header">

data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml

@@ -1,4 +1,4 @@
-<%- unless klass.sections.length == 1 then %>
+<%- unless klass.sections.length == 1 %>
 <div id="sections-section" class="nav-section">
   <details class="nav-section-collapsible" open>
     <summary class="nav-section-header">

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

@@ -1,3 +1,3 @@
-<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
+<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

@@ -3,7 +3,7 @@
 <%= render '_header.rhtml' %>
 <%= render '_sidebar_toggle.rhtml' %>
 
-<nav id="navigation" role="navigation" hidden>
+<nav id="sidebar-navigation" role="navigation" hidden>
   <%= render '_sidebar_pages.rhtml' %>
   <%= render '_sidebar_sections.rhtml' %>
   <%= render '_sidebar_ancestors.rhtml' %>
@@ -22,7 +22,7 @@
         <% if namespace[:self] %>
         <span><%= namespace[:name] %></span>
         <% else %>
-        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span>::</span>
+        <a href="<%= namespace[:path] %>"><%= namespace[:name] %></a><span class="separator">::</span>
         <% end %>
       </li>
       <% end %>
@@ -30,8 +30,9 @@
   <% end %>
 
   <span id="<%= h klass.legacy_aref %>" class="legacy-anchor"></span>
-  <h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
-    <%= klass.type %> <%= klass.full_name %>
+  <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">
@@ -40,32 +41,32 @@
 
   <%- klass.each_section do |section, constants, attributes| %>
   <span id="<%= section.legacy_aref %>" class="legacy-anchor"></span>
-  <section id="<%= section.aref %>" class="documentation-section anchor-link">
-    <%- if section.title then %>
+  <section class="documentation-section anchor-link">
+    <%- if section.title %>
     <header class="documentation-section-title">
-      <h2>
+      <h2 id="<%= section.aref %>">
         <a href="#<%= section.aref %>"><%= section.title %></a>
       </h2>
     </header>
     <%- end %>
 
-    <%- if section.comment then %>
+    <%- if section.comment %>
     <div>
       <%= section.description %>
     </div>
     <%- end %>
 
-    <%- unless constants.empty? then %>
+    <%- unless constants.empty? %>
     <section class="constants-list">
       <header>
-        <h3 id="constants"><a href="#constants">Constants</a></h3>
+        <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 then %>
+        <%- if const.comment %>
         <dd>
-          <%- if const.mixin_from then %>
+          <%- 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>
@@ -80,10 +81,10 @@
     </section>
     <%- end %>
 
-    <%- unless attributes.empty? then %>
+    <%- unless attributes.empty? %>
     <section class="attribute-method-details method-section">
       <header>
-        <h3 id="attributes"><a href="#attributes">Attributes</a></h3>
+        <h3 id="<%= section.aref %>-attributes"><a href="#<%= section.aref %>-attributes">Attributes</a></h3>
       </header>
 
       <%- attributes.each do |attrib| %>
@@ -93,15 +94,18 @@
             <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 then %>
+        <%- 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 then %>
+        <%- if attrib.comment %>
         <%= attrib.description.strip %>
         <%- else %>
         <p class="missing-docs">(Not documented)</p>
@@ -118,76 +122,82 @@
     <%- next if methods.empty? %>
      <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section anchor-link">
        <header>
-         <h3 id="<%= visibility %>-<%= type %>-methods"><a href="#<%= visibility %>-<%= type %>-methods"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</a></h3>
+         <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">
-          <%- if (call_seq = method.call_seq) then %>
-            <%- call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+          <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-callseq">
-                    <%= h(call_seq.strip.
-                        gsub( /^\w+\./m, '')).
-                        gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
-                  </span>
+                  <span class="method-name"><%= h method.name %></span>
+                  <span class="method-args"><%= h method.param_seq %></span>
                 </a>
               </div>
             <%- end %>
-          <%- elsif method.has_call_seq? then %>
-            <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>
+
+            <%- 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-controls">
-            <details class="method-source-toggle">
-              <summary>Source</summary>
-            </details>
-          </div>
           <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? then %>
+        <%- unless method.skip_description? %>
         <div class="method-description">
-          <%- if method.mixin_from then %>
+          <%- 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 then %>
+          <%- if method.comment %>
           <%= method.description.strip %>
           <%- else %>
           <p class="missing-docs">(Not documented)</p>
           <%- end %>
-          <%- if method.calls_super then %>
+          <%- if method.calls_super %>
             <div class="method-calls-super">
               Calls superclass method
-              <%=
-                  method.superclass_method ?
-                  method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
-              %>
+              <%= method.superclass_method_link %>
             </div>
           <%- end %>
         </div>
         <%- end %>
 
-        <%- unless method.aliases.empty? then %>
+        <%- unless method.aliases.empty? %>
         <div class="aliases">
           Also aliased as: <%= method.aliases.map do |aka|
             if aka.parent then # HACK lib/rexml/encodings
@@ -199,7 +209,7 @@
         </div>
         <%- end %>
 
-        <%- if method.is_alias_for then %>
+        <%- 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>