Class: JsDuck::Tag::Localdoc

Inherits:
Tag
  • Object
show all
Defined in:
lib/jsduck/tag/localdoc.rb

Overview

Non-inheritable documentation

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, Tag::PRIORITY_CLASS, Tag::PRIORITY_COMPONENT, Tag::PRIORITY_SINGLETON

Instance Attribute Summary

Attributes inherited from Tag

#class_icon, #css, #ext_define_default, #ext_define_pattern, #html_position, #pattern, #repeatable, #signature, #tagname

Instance Method Summary collapse

Methods inherited from Tag

descendants, #parse_ext_define

Constructor Details

#initialize ⇒ Localdoc

Returns a new instance of Localdoc.



7
8
9
10
11
 
# File 'lib/jsduck/tag/localdoc.rb', line 7

def initialize
  @pattern = "localdoc"
  @tagname = :localdoc
  @html_position = POS_LOCALDOC
end

Instance Method Details

#format(m, formatter) ⇒ Object 



24
25
26
 
# File 'lib/jsduck/tag/localdoc.rb', line 24

def format(m, formatter)
  m[:localdoc] = formatter.format(m[:localdoc])
end

#parse_doc(p, pos) ⇒ Object 



13
14
15
16
17
18
 
# File 'lib/jsduck/tag/localdoc.rb', line 13

def parse_doc(p, pos)
  {
    :tagname => :localdoc,
    :doc => :multiline,
  }
end

#process_doc(m, tags, pos) ⇒ Object 



20
21
22
 
# 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) ⇒ Object 



28
29
30
 
# File 'lib/jsduck/tag/localdoc.rb', line 28

def to_html(m)
  m[:localdoc]
end