class JsDuck::Tag::Throws

Public Class Methods

new() click to toggle source
# File lib/jsduck/tag/throws.rb, line 6
def initialize
  @pattern = "throws"
  @tagname = :throws
  @repeatable = true
  @html_position = POS_THROWS
end

Public Instance Methods

format(m, formatter) click to toggle source
# File lib/jsduck/tag/throws.rb, line 31
def format(m, formatter)
  m[:throws].each {|t| formatter.format_subproperty(t) }
end
parse_doc(p, pos) click to toggle source

@throws {Type} …

# File lib/jsduck/tag/throws.rb, line 14
def parse_doc(p, pos)
  tag = p.standard_tag({:tagname => :throws, :type => true})
  tag[:doc] = :multiline
  tag
end
process_doc(h, tags, pos) click to toggle source
# File lib/jsduck/tag/throws.rb, line 20
def process_doc(h, tags, pos)
  result = tags.map do |throws|
    {
      :type => throws[:type] || "Object",
      :doc => throws[:doc] || "",
    }
  end

  h[:throws] = result
end
to_html(m) click to toggle source
# File lib/jsduck/tag/throws.rb, line 35
def to_html(m)
  JsDuck::Render::Subproperties.render_throws(m[:throws])
end