Class: JsDuck::Render::Tags

Inherits:
Object
  • Object
show all
Defined in:
lib/jsduck/render/tags.rb

Overview

Performs the rendering of tags.

Class Method Summary collapse

Class Method Details

.render(member) ⇒ Object

Renders tags of a particular section.

Takes member or class hash. Returns array of rendered HTML.



12
13
14
15
16
17
18
19
20
 
# File 'lib/jsduck/render/tags.rb', line 12

def self.render(member)
  TagRegistry.html_renderers.map do |tag|
    if member[tag.tagname]
      tag.to_html(member)
    else
      nil
    end
  end
end

.render_signature(member) ⇒ Object

Renders the signatures for a class member. Returns a string.



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/jsduck/render/tags.rb', line 24

def self.render_signature(member)
  html = []
  TagRegistry.signatures.each do |s|
    if member[s[:tagname]]
      title = s[:tooltip] ? "title='#{s[:tooltip]}'" : ""
      html << "<span class='#{s[:tagname]}' #{title}>#{s[:long]}</span>"
    end
  end
  '<span class="signature">' + html.join + "</span>"
end