Class: JsDuck::Tag::Subproperties

Inherits:
Tag
  • Object
show all
Defined in:
lib/jsduck/tag/subproperties.rb

Overview

There is no @subproperties tag.

This tag class exists solely to implement rendering of :properties field which can exist in :cfg, :property or :css_var members.

Constant Summary

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 Tag

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

Instance Method Summary collapse

Methods inherited from Tag

descendants, #parse_doc, #parse_ext_define, #process_doc

Constructor Details

#initialize ⇒ Subproperties

Returns a new instance of Subproperties.



10
11
12
13
 
# File 'lib/jsduck/tag/subproperties.rb', line 10

def initialize
  @tagname = :properties
  @html_position = POS_SUBPROPERTIES
end

Instance Method Details

#format(m, formatter) ⇒ Object 



15
16
17
 
# File 'lib/jsduck/tag/subproperties.rb', line 15

def format(m, formatter)
  m[:properties].each {|p| formatter.format_subproperty(p) }
end

#to_html(m) ⇒ Object 



19
20
21
 
# File 'lib/jsduck/tag/subproperties.rb', line 19

def to_html(m)
  JsDuck::Render::Subproperties.render(m)
end