Method: YARD::DocstringParser#reference

Defined in:
lib/yard/docstring_parser.rb

#reference ⇒ CodeObjects::Base?

Returns the object referenced by the docstring being parsed. May be nil if the docstring doesn’t refer to any object.

Returns:

  • (CodeObjects::Base, nil) —

    the object referenced by the docstring being parsed. May be nil if the docstring doesn’t refer to any object.

Since:

  • 0.8.0



60
61
62
 
# File 'lib/yard/docstring_parser.rb', line 60

def reference
  @reference
end