Method: YARD::DocstringParser#object

Defined in:
lib/yard/docstring_parser.rb

#object ⇒ CodeObjects::Base?

Returns the object associated with the docstring being parsed. May be nil if the docstring is not attached to any object.

Returns:

  • (CodeObjects::Base, nil) —

    the object associated with the docstring being parsed. May be nil if the docstring is not attached to any object.

Since:

  • 0.8.0



55
56
57
 
# File 'lib/yard/docstring_parser.rb', line 55

def object
  @object
end