Class: JsDuck::Tag::Listener

Inherits:
MemberTag show all
Defined in:
lib/jsduck/tag/listener.rb

Constant Summary

Constants inherited from MemberTag

MemberTag::MEMBER_POS_CFG, MemberTag::MEMBER_POS_CSS_MIXIN, MemberTag::MEMBER_POS_CSS_VAR, MemberTag::MEMBER_POS_EVENT, MemberTag::MEMBER_POS_LISTENER, MemberTag::MEMBER_POS_METHOD, MemberTag::MEMBER_POS_PROPERTY

Constants inherited from Tag

Tag::POS_ASIDE, Tag::POS_DEFAULT, Tag::POS_DEPRECATED, Tag::POS_DOC, Tag::POS_ENUM, Tag::POS_FIRES, Tag::POS_LOCALDOC, Tag::POS_OVERRIDES, Tag::POS_PARAM, Tag::POS_PREVENTABLE, Tag::POS_PRIVATE, Tag::POS_RETURN, Tag::POS_SINCE, Tag::POS_SUBPROPERTIES, Tag::POS_TEMPLATE, Tag::POS_THROWS, Tag::PRIORITY_CLASS, Tag::PRIORITY_COMPONENT, Tag::PRIORITY_SINGLETON

Instance Attribute Summary

Attributes inherited from MemberTag

#member_type

Attributes inherited from Tag

#class_icon, #css, #ext_define_default, #ext_define_pattern, #html_position, #pattern, #repeatable, #signature, #tagname

Instance Method Summary collapse

Methods inherited from MemberTag

#member_link, #member_params, #process_code

Methods inherited from Tag

descendants, #format, #parse_ext_define

Constructor Details

#initialize ⇒ Listener

Returns a new instance of Listener.



6
7
8
9
10
11
12
13
14
 
# File 'lib/jsduck/tag/listener.rb', line 6

def initialize
  @pattern = "listener"
  @tagname = :listener
  @member_type = {
    :title => "Listeners",
    :position => MEMBER_POS_LISTENER,
    :icon => File.dirname(__FILE__) + "/icons/listener.png"
  }
end

Instance Method Details

#merge(h, docs, code) ⇒ Object 



28
29
30
 
# File 'lib/jsduck/tag/listener.rb', line 28

def merge(h, docs, code)
  JsDuck::ParamsMerger.merge(h, docs, code)
end

#parse_doc(p, pos) ⇒ Object 



17
18
19
20
21
22
 
# File 'lib/jsduck/tag/listener.rb', line 17

def parse_doc(p, pos)
  {
    :tagname => :listener,
    :name => p.ident,
  }
end

#process_doc(h, tags, pos) ⇒ Object 



24
25
26
 
# File 'lib/jsduck/tag/listener.rb', line 24

def process_doc(h, tags, pos)
  h[:name] = tags[0][:name]
end

#to_html(listener, cls) ⇒ Object 



32
33
34
 
# File 'lib/jsduck/tag/listener.rb', line 32

def to_html(listener, cls)
  member_link(listener) + member_params(listener[:params])
end