class YARD::DocstringParser

def parse(content, object = nil, handler = nil)

Other tags:
    See: #to_docstring -

Returns:
  • (self) - the parser object. To get the docstring,

Parameters:
  • handler (Handlers::Base, nil) -- the handler object that is
  • object (CodeObjects::Base) -- the object that the docstring
  • content (String) -- the docstring text to parse 
def parse(content, object = nil, handler = nil)
  @object = object
  @handler = handler
  @reference, @raw_text = detect_reference(content)
  text = parse_content(@raw_text)
  @text = text.strip
  call_directives_after_parse
  post_process
  self
end