<body id=âtopâ role=âdocumentâ class=â<%= klass.type %> has-tocâ> <%= render â_header.rhtmlâ %> <%= render â_sidebar_toggle.rhtmlâ %>
<nav id=ânavigationâ role=ânavigationâ>
<%= render '_sidebar_pages.rhtml' %> <%= render '_sidebar_sections.rhtml' %> <%= render '_sidebar_ancestors.rhtml' %> <%= render '_sidebar_includes.rhtml' %> <%= render '_sidebar_extends.rhtml' %> <%= render '_sidebar_methods.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>::</span>
<% end %>
</li>
<% end %>
</ol>
<% end %>
<h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
<%= klass.type %> <%= klass.full_name %>
</h1>
<section class="description">
<%= klass.description %>
</section>
<%- klass.each_section do |section, constants, attributes| %>
<section id="<%= section.aref %>" class="documentation-section anchor-link">
<%- if section.title then %>
<header class="documentation-section-title">
<h2>
<%= section.title %>
</h2>
<span class="section-click-top">
<a href="#top">↑ top</a>
</span>
</header>
<%- end %>
<%- if section.comment then %>
<div>
<%= section.description %>
</div>
<%- end %>
<%- unless constants.empty? then %>
<section class="constants-list">
<header>
<h3 id="constants">Constants</h3>
</header>
<dl>
<%- constants.each do |const| %>
<dt id="<%= const.name %>"><%= const.name %></dt>
<%- if const.comment then %>
<dd>
<%- if const.mixin_from then %>
<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? then %>
<section class="attribute-method-details method-section">
<header>
<h3 id="attributes">Attributes</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>
</div>
<div class="method-description">
<%- if attrib.mixin_from then %>
<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 %>
<%= 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 %>-methods"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</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">
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-callseq">
<%= h(call_seq.strip.
gsub( /^\w+\./m, '')).
gsub(/(.*)[-=]>/, '\1→') %>
</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>
</div>
<%- end %>
</div>
<%- if method.token_stream %>
<div class="method-controls">
<details class="method-source-toggle">
<summary>Source</summary>
</details>
</div>
<%- end %>
<%- unless method.skip_description? then %>
<div class="method-description">
<%- if method.token_stream then %>
<div class="method-source-code" id="<%= method.html_name %>-source">
<pre><%= method.markup_code %></pre>
</div>
<%- end %>
<%- if method.mixin_from then %>
<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 %>
<%= method.description.strip %>
<%- else %>
<p class="missing-docs">(Not documented)</p>
<%- end %>
<%- if method.calls_super then %>
<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
%>
</div>
<%- end %>
</div>
<%- end %>
<%- unless method.aliases.empty? then %>
<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 then %>
<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>