Class: DeltaCloud::Documentation::OperationParameter

Inherits:

Object

• Object
• DeltaCloud::Documentation::OperationParameter

show all

Defined in:

lib/deltacloud.rb

Instance Attribute Summary (collapse)

• - (Object) description readonly

  Returns the value of attribute description.

• - (Object) name readonly

  Returns the value of attribute name.

• - (Object) required readonly

  Returns the value of attribute required.

• - (Object) type readonly

  Returns the value of attribute type.

Instance Method Summary (collapse)

• - (OperationParameter) initialize(data) constructor

  A new instance of OperationParameter.

• - (Object) to_comment

399
400
401

# File 'lib/deltacloud.rb', line 399

def initialize(data)
  @name, @type, @required, @description = data[:name], data[:type], data[:required], data[:description]
end

397
398
399

# File 'lib/deltacloud.rb', line 397

def description
  @description
end

394
395
396

# File 'lib/deltacloud.rb', line 394

def name
  @name
end

396
397
398

# File 'lib/deltacloud.rb', line 396

def required
  @required
end

395
396
397

# File 'lib/deltacloud.rb', line 395

def type
  @type
end

403
404
405

# File 'lib/deltacloud.rb', line 403

def to_comment
  "   # @param [#{@type}, #{@name}] #{@description}"
end