Class: RubyLint::Docstring::ReturnTag

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-lint/docstring/return_tag.rb

Overview

The ReturnTag class contains information about a YARD @return tag.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ReturnTag

Returns a new instance of ReturnTag

Parameters:

  • options (Hash) (defaults to: {}) 


18
19
20
21
 
# File 'lib/ruby-lint/docstring/return_tag.rb', line 18

def initialize(options = {})
  @types       = options[:types] || []
  @description = options[:description]
end

Instance Attribute Details

#description ⇒ String (readonly)

Returns:



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/ruby-lint/docstring/return_tag.rb', line 12

class ReturnTag
  attr_reader :types, :description

  ##
  # @param [Hash] options
  #
  def initialize(options = {})
    @types       = options[:types] || []
    @description = options[:description]
  end
end

#types ⇒ Array (readonly)

Returns:

  • (Array) 


12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/ruby-lint/docstring/return_tag.rb', line 12

class ReturnTag
  attr_reader :types, :description

  ##
  # @param [Hash] options
  #
  def initialize(options = {})
    @types       = options[:types] || []
    @description = options[:description]
  end
end