Class: Solargraph::Pin::Reference::Override

Inherits:
Reference
  • Object
show all
Defined in:
lib/solargraph/pin/reference/override.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(location, name, tags, delete = [], **splat) ⇒ Override

Returns a new instance of Override.

Parameters:

  • location (Location, nil)
  • name (String)
  • tags (::Array<YARD::Tags::Tag>)
  • delete (::Array<Symbol>) (defaults to: [])
  • splat (Hash) 


22
23
24
25
26
 
# File 'lib/solargraph/pin/reference/override.rb', line 22

def initialize location, name, tags, delete = [], **splat
  super(location: location, name: name, **splat)
  @tags = tags
  @delete = delete
end

Instance Attribute Details

#delete ⇒ ::Array<::Symbol> (readonly)

Returns:

  • (::Array<::Symbol>) 


11
12
13
 
# File 'lib/solargraph/pin/reference/override.rb', line 11

def delete
  @delete
end

#tags ⇒ ::Array<YARD::Tags::Tag> (readonly)

Returns:

  • (::Array<YARD::Tags::Tag>) 


8
9
10
 
# File 'lib/solargraph/pin/reference/override.rb', line 8

def tags
  @tags
end

Class Method Details

.from_comment(name, comment, **splat) ⇒ Solargraph::Pin::Reference::Override

Parameters:

  • name (String)
  • comment (String)
  • splat (Hash)

Returns:



41
42
43
 
# File 'lib/solargraph/pin/reference/override.rb', line 41

def self.from_comment name, comment, **splat
  new(nil, name, Solargraph::Source.parse_docstring(comment).to_docstring.tags, **splat)
end

.method_return(name, *tags, delete: [], **splat) ⇒ Solargraph::Pin::Reference::Override

Parameters:

  • name (String)
  • tags (::Array<String>)
  • delete (::Array<Symbol>) (defaults to: [])
  • splat (Hash)

Returns:



33
34
35
 
# File 'lib/solargraph/pin/reference/override.rb', line 33

def self.method_return name, *tags, delete: [], **splat
  new(nil, name, [YARD::Tags::Tag.new('return', '', tags)], delete, **splat)
end

Instance Method Details

#closure ⇒ Object 



13
14
15
 
# File 'lib/solargraph/pin/reference/override.rb', line 13

def closure
  nil
end