Class: JsDuck::Categories::ClassName

Inherits:
Object
  • Object
show all
Defined in:
lib/jsduck/categories/class_name.rb

Overview

Renders class names for class categories page.

Instance Method Summary collapse

Constructor Details

#initialize(doc_formatter, relations = {}) ⇒ ClassName

Returns a new instance of ClassName.



6
7
8
9
 
# File 'lib/jsduck/categories/class_name.rb', line 6

def initialize(doc_formatter, relations={})
  @doc_formatter = doc_formatter
  @relations = relations
end

Instance Method Details

#render(name) ⇒ Object

Renders the class name as a link or plain text.

For new classes appends a star behind class name. For classes with new members appends list n small stars behind class name (reflecting the number of new members).



16
17
18
19
20
21
22
23
 
# File 'lib/jsduck/categories/class_name.rb', line 16

def render(name)
  cls = @relations[name]
  if cls
    @doc_formatter.link(name, nil, name) + render_new_label(cls)
  else
    name
  end
end