class ApipieDSL::ReturnDescription

Public Class Methods

from_dsl_data(method_description, args) click to toggle source
# File lib/apipie_dsl/return_description.rb, line 47
def self.from_dsl_data(method_description, args)
  options, block = args

  new(method_description, options, block)
end
new(method_description, options, block) click to toggle source
# File lib/apipie_dsl/return_description.rb, line 53
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

Public Instance Methods

docs(lang = nil) click to toggle source
# File lib/apipie_dsl/return_description.rb, line 63
def docs(lang = nil)
  {
    description: @description,
    object: @returns_object.docs(lang)
  }
end