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

463
464
465

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

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

461
462
463

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

def description
  @description
end

458
459
460

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

def name
  @name
end

460
461
462

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

def required
  @required
end

459
460
461

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

def type
  @type
end

467
468
469

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

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