Method: JsDuck::Tag::Tag#parse_doc

Defined in:

lib/jsduck/tag/tag.rb

#parse_doc(scanner, position) ⇒ Object

Called by DocParser when the @tag is reached to do the parsing from that point forward. Gets passed an instance of DocScanner.

Can return a hash or array of hashes representing the detected e.g.:

{:tagname => :protected, :foo => "blah"}

All hashes with the same :tagname will later be combined together and passed on to #process_doc method of this Tag class that has @tagname field set to that tagname.

The hash can also contain :doc => :multiline, in which case all the documentation following this tag will get added to the :doc field of the tag and will later be accessible in #process_doc method.

Also a hash with position information :linenr is passed in.

# File 'lib/jsduck/tag/tag.rb', line 34

def parse_doc(scanner, position)
end