class YARD::Handlers::Base

def register_docstring(object, docstring = statement.comments, stmt = statement)

Other tags:
    Since: - 0.8.0

Returns:
  • (void) -

Parameters:
  • object (CodeObjects::Base) -- the object to register
def register_docstring(object, docstring = statement.comments, stmt = statement)
  docstring = docstring.join("\n") if Array === docstring
  parser = Docstring.parser
  parser.parse(docstring || "", object, self)
  if object && docstring
    object.docstring = parser.to_docstring
    # Add hash_flag/line_range
    if stmt
      object.docstring.hash_flag = stmt.comments_hash_flag
      object.docstring.line_range = stmt.comments_range
    end
  end
  register_transitive_tags(object)
end