class JsDuck::Tag::Localdoc

Non-inheritable documentation

Public Class Methods

new() click to toggle source
# File lib/jsduck/tag/localdoc.rb, line 7
def initialize
  @pattern = "localdoc"
  @tagname = :localdoc
  @html_position = POS_LOCALDOC
end

Public Instance Methods

format(m, formatter) click to toggle source
# File lib/jsduck/tag/localdoc.rb, line 24
def format(m, formatter)
  m[:localdoc] = formatter.format(m[:localdoc])
end
parse_doc(p, pos) click to toggle source
# File lib/jsduck/tag/localdoc.rb, line 13
def parse_doc(p, pos)
  {
    :tagname => :localdoc,
    :doc => :multiline,
  }
end
process_doc(m, tags, pos) click to toggle source
# File lib/jsduck/tag/localdoc.rb, line 20
def process_doc(m, tags, pos)
  m[:localdoc] = tags.map {|t| t[:doc] }.join("\n\n")
end
to_html(m) click to toggle source
# File lib/jsduck/tag/localdoc.rb, line 28
def to_html(m)
  m[:localdoc]
end