Class: YARD::Tags::OverloadTag

Inherits:

Tag

• Object
• Tag
• YARD::Tags::OverloadTag

show all

Defined in:

lib/yard/tags/overload_tag.rb

Instance Attribute Summary (collapse)

• - (Object) docstring readonly

  Returns the value of attribute docstring.

• - (Object) parameters readonly

  Returns the value of attribute parameters.

• - (Object) signature readonly

  Returns the value of attribute signature.

Attributes inherited from Tag

#object, #tag_name, #text, #types

Instance Method Summary (collapse)

• - (Boolean) has_tag?(name)
• - (OverloadTag) initialize(tag_name, text) constructor

  A new instance of OverloadTag.

• - (Boolean) is_a?(other) (also: #kind_of?)
• - (Object) method_missing(*args, &block)
• - (Object) name(prefix = false)
• - (Object) object=(value)
• - (Object) tag(name)
• - (Object) tags(name = nil)
• - (Object) type

6
7
8
9
10

# File 'lib/yard/tags/overload_tag.rb', line 6

def initialize(tag_name, text)
  super(tag_name, nil)
  parse_tag(text)
  parse_signature
end

26
27
28

# File 'lib/yard/tags/overload_tag.rb', line 26

def method_missing(*args, &block)
  object.send(*args, &block)
end

4
5
6

# File 'lib/yard/tags/overload_tag.rb', line 4

def docstring
  @docstring
end

4
5
6

# File 'lib/yard/tags/overload_tag.rb', line 4

def parameters
  @parameters
end

4
5
6

# File 'lib/yard/tags/overload_tag.rb', line 4

def signature
  @signature
end

14

# File 'lib/yard/tags/overload_tag.rb', line 14

def has_tag?(name) docstring.has_tag?(name) end

34
35
36

# File 'lib/yard/tags/overload_tag.rb', line 34

def is_a?(other)
  object.is_a?(other) || self.class >= other.class || false
end

21
22
23
24

# File 'lib/yard/tags/overload_tag.rb', line 21

def name(prefix = false)
  return @name unless prefix
  object.scope == :class ? @name.to_s : "#{object.send(:sep)}#{@name}"
end

16
17
18
19

# File 'lib/yard/tags/overload_tag.rb', line 16

def object=(value)
  super(value)
  docstring.object = value
end

12

# File 'lib/yard/tags/overload_tag.rb', line 12

def tag(name) docstring.tag(name) end

13

# File 'lib/yard/tags/overload_tag.rb', line 13

def tags(name = nil) docstring.tags(name) end

30
31
32

# File 'lib/yard/tags/overload_tag.rb', line 30

def type
  object.type
end