class YARD::Docstring

def self.new!(text, tags = [], object = nil, raw_data = nil, ref_object = nil)

Parameters:
  • ref_object (CodeObjects::Base, nil) -- a reference object used for
  • raw_data (String) -- the complete docstring, including all
  • object (CodeObjects::Base, nil) -- the object associated with the
  • tags (Array) -- the list of tag objects in the docstring
  • text (String) -- the textual portion of the docstring 
def self.new!(text, tags = [], object = nil, raw_data = nil, ref_object = nil)
  docstring = allocate
  docstring.replace(text, false)
  docstring.object = object
  docstring.add_tag(*tags)
  docstring.instance_variable_set("@unresolved_reference", ref_object)
  docstring.instance_variable_set("@all", raw_data) if raw_data
  docstring
end