Class: ApipieDSL::ReturnDescription

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

Defined Under Namespace

Classes: ReturnObject

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method_description, options, block) ⇒ ReturnDescription

Returns a new instance of ReturnDescription.



52
53
54
55
56
57
58
59
 
# File 'lib/apipie_dsl/return_description.rb', line 52

def initialize(method_description, options, block)
  if options[:array_of] && options[:one_of] && options[:object_of] && options[:param_group]
    raise ReturnsMultipleDefinitionError, options
  end

  @description = options[:desc]
  @returns_object = ReturnObject.new(method_description, options, block)
end

Class Method Details

.from_dsl_data(method_description, args) ⇒ Object 



46
47
48
49
50
 
# File 'lib/apipie_dsl/return_description.rb', line 46

def self.from_dsl_data(method_description, args)
  options, block = args

  new(method_description, options, block)
end

Instance Method Details

#docs(lang = nil) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/apipie_dsl/return_description.rb', line 62

def docs(lang = nil)
  {
    description: @description,
    object: @returns_object.docs(lang)
  }
end