Class: ApipieDSL::SeeDescription

Inherits:
Object
  • Object
show all
Defined in:
lib/apipie_dsl/see_description.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method, options = {}) ⇒ SeeDescription

Returns a new instance of SeeDescription.



7
8
9
10
11
12
# File 'lib/apipie_dsl/see_description.rb', line 7

def initialize(method, options = {})
  @method = method
  @link = options[:link]
  @description = options[:desc] || options[:description]
  @scope = options[:scope]
end

Instance Attribute Details

#descriptionObject (readonly)

Returns the value of attribute description.



5
6
7
# File 'lib/apipie_dsl/see_description.rb', line 5

def description
  @description
end

Returns the value of attribute link.



5
6
7
# File 'lib/apipie_dsl/see_description.rb', line 5

def link
  @link
end

Instance Method Details

#docsObject



14
15
16
# File 'lib/apipie_dsl/see_description.rb', line 14

def docs
  { link: link, url: see_url, description: description }
end