Class: JsDuck::Tag::Removed

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

Overview

To document members that were present in previous version but are completely gone now. Other than that it behaves exactly like

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

Instance Attribute Summary

Attributes inherited from Tag

#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 ⇒ Removed

Returns a new instance of Removed.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/jsduck/tag/removed.rb', line 8

def initialize
  @tagname = :removed
  @msg = "This {TAGNAME} has been <strong>removed</strong>"
  # striked-through text with red border.
  @css = <<-EOCSS
    .signature .removed {
      color: #aa0000;
      background-color: transparent;
      border: 1px solid #aa0000;
      text-decoration: line-through;
    }
    .removed-box {
      border: 2px solid #aa0000;
    }
    .removed-box strong {
      color: #aa0000;
      border: 2px solid #aa0000;
      background-color: transparent;
      text-decoration: line-through;
    }
  EOCSS
  super
end