Class: JsDuck::Tag::Event
- Defined in:
- lib/jsduck/tag/event.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
Attributes inherited from Tag
#class_icon, #css, #ext_define_default, #ext_define_pattern, #html_position, #pattern, #repeatable, #signature, #tagname
Instance Method Summary collapse
-
#initialize ⇒ Event
constructor
A new instance of Event.
- #merge(h, docs, code) ⇒ Object
- #parse_doc(p, pos) ⇒ Object
- #process_doc(h, tags, pos) ⇒ Object
- #to_html(event, cls) ⇒ Object
Methods inherited from MemberTag
#member_link, #member_params, #process_code
Methods inherited from Tag
descendants, #format, #parse_ext_define
Constructor Details
#initialize ⇒ Event
Returns a new instance of Event.
6 7 8 9 10 11 12 13 14 |
# File 'lib/jsduck/tag/event.rb', line 6 def initialize @pattern = "event" @tagname = :event @member_type = { :title => "Events", :position => MEMBER_POS_EVENT, :icon => File.dirname(__FILE__) + "/icons/event.png" } end |
Instance Method Details
#merge(h, docs, code) ⇒ Object
28 29 30 |
# File 'lib/jsduck/tag/event.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/event.rb', line 17 def parse_doc(p, pos) { :tagname => :event, :name => p.ident, } end |
#process_doc(h, tags, pos) ⇒ Object
24 25 26 |
# File 'lib/jsduck/tag/event.rb', line 24 def process_doc(h, , pos) h[:name] = [0][:name] end |
#to_html(event, cls) ⇒ Object
32 33 34 |
# File 'lib/jsduck/tag/event.rb', line 32 def to_html(event, cls) member_link(event) + member_params(event[:params]) end |