<%= klass.full_name %>

In Files

<% if klass.type == 'class' %>

Parent

<% unless String === klass.superclass or klass.superclass.nil? %>

<%= klass.superclass.full_name %>

<% else %>

<%= klass.superclass %>

<% end %>
<% end %> <% unless klass.includes.empty? %>

Included Modules

    <% klass.each_include do |inc| %> <% unless String === inc.module %>
  • <%= inc.module.full_name %>
    • <% else %>
  • <%= inc.name %>
    • <% end %> <% end %>
<% end %>
<% if $DEBUG_RDOC %>
toggle debugging
<% end %>
<%= klass.description %>
<% unless klass.constants.empty? %>

Constants

<% klass.each_constant do |const| %>
<%= const.name %>
<% if const.comment %>
<%= const.description.strip %>
<% else %>
(Not documented)
<% end %> <% end %>
<% end %> <% unless klass.attributes.empty? %>

Attributes

<% klass.each_attribute do |attrib| %>
<% if attrib.rw =~ /w/i %> <% end %>
<%= h attrib.name %>[<%= attrib.rw %>]
<% if attrib.comment %> <%= attrib.description.strip %> <% else %>

(Not documented)

<% end %>
<% end %>
<% end %> <% klass.methods_by_type.each do |type, visibilities| next if visibilities.empty? visibilities.each do |visibility, methods| next if methods.empty? %>

<%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods

<% methods.each do |method| %>
">
<% if method.call_seq %> <%= method.call_seq.strip.gsub(/->/, '→').gsub( /^\w+\./m, '') %> click to toggle source <% else %> <%= h method.name %><%= method.params %> click to toggle source <% end %>
<% if method.comment %> <%= method.description.strip %> <% else %>

(Not documented)

<% end %> <% if method.token_stream %> 
<%= method.markup_code %>
<% end %>
<% unless method.aliases.empty? %>
Also aliased as: <%= method.aliases.map do |aka| %{#{h aka.name}} end.join(", ") %>
<% end %>
<% end %>
<% end end %>
<% if $DEBUG_RDOC require 'pp' %> 
<%= h PP.pp(klass, _erbout) %>
<% else %>

Disabled; run with --debug to generate this.

<% end %>

[Validate]

Generated with the Darkfish Rdoc Generator <%= RDoc::Generator::Darkfish::VERSION %>.