Home Classes Methods

In Files

<%= h tl.absolute_name %>

<% if !svninfo.empty? then %>

Subversion Info

Rev: <%= svninfo[:rev] %>
Last Checked In: <%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %> (<%= svninfo[:commitdelta] %> ago)
Checked in by: <%= svninfo[:committer] %>

<% end %>

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

Parent

<% if klass.superclass and not String === klass.superclass then %>

<%= klass.superclass.full_name %>

<% else %>

<%= klass.superclass %>

<% end %>

<% end %> <% unless klass.sections.length == 1 then %>

Sections

<%= h section.title %>

<% end %> <% unless klass.classes_and_modules.empty? then %>

Namespace

<%= mod.type.upcase %> <%= mod.full_name %>

<% end %> <% unless klass.method_list.empty? then %>

Methods

<%= meth.singleton ? '::' : '#' %><%= meth.name %>

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

Included Modules

<%= inc.module.full_name %>
<%= inc.name %>

<% end %>

<% simple_files = @files.select {|tl| tl.parser == RDoc::Parser::Simple } %> <% unless simple_files.empty? then %>

Files

<%= h file.base_name %>

<% end %>

Class/Module Index

<%= index_klass.full_name %>

<% if $DEBUG_RDOC then %>

<% end %>

<%= klass.full_name %>

<%= klass.description %>

<% klass.each_section do |section, constants, attributes| %> <% constants = constants.select { |const| const.display? } %> <% attributes = attributes.select { |attr| attr.display? } %>

<% if section.title then %>

<%= section.title %> ↑ top

<% end %> <% if section.comment then %>

<%= section.description %>

<% end %> <% unless constants.empty? then %>

Constants

<%= const.name %>: <%= const.description.strip %>; (Not documented)

<% end %> <% unless attributes.empty? then %>

Attributes

<% attributes.each do |attrib| %>

<% if attrib.rw =~ /w/i then %> <% end %>

<%= h attrib.name %>[<%= attrib.rw %>]

<% if attrib.comment then %> <%= attrib.description.strip %> <% else %>

(Not documented)

<% end %>

<% end %> <% klass.methods_by_type(section).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 then %> <% method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>

<%= call_seq.strip.gsub(/->/, '→').gsub( /^\w+\./m, '') %> <% if i == 0 then %> click to toggle source <% end %>

<% end %> <% else %>

<%= h method.name %><%= method.params %> click to toggle source

<% end %>

<% if method.comment then %> <%= method.description.strip %> <% else %>

(Not documented)

<% end %> <% if method.token_stream then %>

<%= method.markup_code %>

<% end %>

<% unless method.aliases.empty? then %>

Also aliased as: <%= method.aliases.map do |aka| if aka.parent then # HACK lib/rexml/encodings %{#{h aka.name}} else h aka.name end end.join ", " %>

<% end %> <% if method.is_alias_for then %>

Alias for: <%= h method.is_alias_for.name %>

<% end %>

<% end end %>

<% end %>