Sha256: 09e362db09611225a780d7757bd47368bec8d7fc8bd4f7584c3440172c30764b

Contents?: true

Size: 916 Bytes

Versions: 47

Compression:

Stored size: 916 Bytes

Contents

require "jsduck/meta_tag"

module JsDuck::Tag
  # Implementation of @removed tag.
  #
  # To document members that were present in previous version but are
  # completely gone now.  Other than that it behaves exactly like @deprecated.
  class Removed < JsDuck::MetaTag
    def initialize
      @name = "removed"
      @key = :removed
      @signature = {:long => "removed", :short => "REM"}
      @multiline = true
    end

    def to_value(contents)
      text = contents[0]
      if text =~ /\A([0-9.]+)(.*)\Z/
        {:version => $1, :text => $2.strip}
      else
        {:text => text || ""}
      end
    end

    def to_html(val)
      ver = val[:version] ? "since " + val[:version] : ""
      <<-EOHTML
        <div class='signature-box removed'>
        <p>This #{@context[:tagname]} has been <strong>removed</strong> #{ver}</p>
        #{format(val[:text])}
        </div>
      EOHTML
    end
  end
end

Version data entries

47 entries across 47 versions & 1 rubygems

Version Path
jsduck-4.10.4 lib/jsduck/tag/removed.rb
jsduck-4.10.3 lib/jsduck/tag/removed.rb
jsduck-4.10.2 lib/jsduck/tag/removed.rb
jsduck-4.10.1 lib/jsduck/tag/removed.rb
jsduck-4.10.0 lib/jsduck/tag/removed.rb
jsduck-4.9.0 lib/jsduck/tag/removed.rb
jsduck-4.8.0 lib/jsduck/tag/removed.rb
jsduck-4.7.1 lib/jsduck/tag/removed.rb
jsduck-4.7.0 lib/jsduck/tag/removed.rb
jsduck-4.6.2 lib/jsduck/tag/removed.rb
jsduck-4.6.1 lib/jsduck/tag/removed.rb
jsduck-4.6.0 lib/jsduck/tag/removed.rb
jsduck-4.5.1 lib/jsduck/tag/removed.rb
jsduck-4.5.0 lib/jsduck/tag/removed.rb
jsduck-4.4.1 lib/jsduck/tag/removed.rb
jsduck-4.4.0 lib/jsduck/tag/removed.rb
jsduck-4.3.2 lib/jsduck/tag/removed.rb
jsduck-4.3.1 lib/jsduck/tag/removed.rb
jsduck-4.3.0 lib/jsduck/tag/removed.rb
jsduck-4.2.1 lib/jsduck/tag/removed.rb