Module: R2Doc::ClassExtensions

Defined in:
lib/r2doc/context_extensions.rb

Overview

Extensions for the RDoc::Generator::Class / Generators::HtmlClass class

Instance Method Summary collapse

Instance Method Details

#short_name ⇒ Object

Return the shorter, unqualified name of the class



213
214
215
 
# File 'lib/r2doc/context_extensions.rb', line 213

def short_name
  @context.name
end

#superclass ⇒ Object

Return the HtmlClass for the super class, or the class name if undocumented



204
205
206
207
208
209
210
 
# File 'lib/r2doc/context_extensions.rb', line 204

def superclass
  lookup = (parent_name) ? "#{parent_name}::#{context_superclass}" : context_superclass
  s = R2Doc.all_references[lookup] || R2Doc.all_references[context_superclass] || context_superclass
   # in some cases conflicting method names can pollute AllReferences
  s = s.name if (s.respond_to?(:is_method_context?) && s.is_method_context?)
  s == self ? nil : s
end