class JsDuck::Tag::Default

There is no @default tag.

Default values are detected from syntax like this:

@cfg [blah=somedefault]

This tag class exists to generate the “Defaults to:” text in final HTML.

Public Class Methods

new() click to toggle source
# File lib/jsduck/tag/default.rb, line 14
def initialize
  @tagname = :default
  @html_position = POS_DEFAULT
end

Public Instance Methods

to_html(m) click to toggle source
# File lib/jsduck/tag/default.rb, line 19
def to_html(m)
  return if m[:default] == "undefined"

  "<p>Defaults to: <code>" + JsDuck::Util::HTML.escape(m[:default]) + "</code></p>"
end