Class: YARD::TomDocParser

Inherits:
DocstringParser show all
Defined in:
lib/yard-tomdoc/yard081.rb

Overview

Plugin parser for parsing TomDoc formatted comments.

Instance Method Summary collapse

Methods inherited from DocstringParser

#parse, #parse_tomdoc

Instance Method Details

#parse_content(content) ⇒ Object



8
9
10
11
12
13
14
15
# File 'lib/yard-tomdoc/yard081.rb', line 8

def parse_content(content)
  # TODO: move TomDoc.yard_parse code to here when old versions are no longer supported
  tomdoc = TomDoc.yard_parse(self, content)
  text   = tomdoc.description.to_s

  # Remove trailing/leading whitespace / newlines
  @text = text.gsub(/\A[\r\n\s]+|[\r\n\s]+\Z/, '')
end