Class: JsDuck::Tag::Deprecated

Inherits:
DeprecatedTag show all
Defined in:
lib/jsduck/tag/deprecated.rb

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 DeprecatedTag

#format, #parse_doc, #process_doc, #to_html

Methods inherited from Tag

descendants, #format, #parse_doc, #parse_ext_define, #process_doc, #to_html

Constructor Details

#initialize ⇒ Deprecated

Returns a new instance of Deprecated.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/jsduck/tag/deprecated.rb', line 5

def initialize
  @tagname = :deprecated
  @msg = "This {TAGNAME} has been <strong>deprecated</strong>"
  @css = <<-EOCSS
    .signature .deprecated {
      background-color: #aa0000;
    }
    .deprecated-box {
      border: 2px solid #aa0000;
    }
    .deprecated-box strong {
      color: white;
      background-color: #aa0000;
    }
  EOCSS
  super
end