Class: Aws::Api::Docs::ParamFormatter Private

Inherits:
Object
  • Object
show all
Includes:
Utils, Seahorse::Model::Shapes
Defined in:
lib/aws-sdk-core/api/docs/param_formatter.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Method Summary collapse

Methods included from Utils

#compute_recursive_shapes, #document_struct_member, #input_type, #operation_input_ref, #output_type, #struct_member_docstring, #summary, #tag

Constructor Details

#initialize(shape_ref) ⇒ ParamFormatter

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ParamFormatter.


9
10
11
12
# File 'lib/aws-sdk-core/api/docs/param_formatter.rb', line 9

def initialize(shape_ref)
  @shape_ref = shape_ref
  @recursive_shapes = compute_recursive_shapes(@shape_ref)
end

Instance Method Details

#formatObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


14
15
16
17
18
19
20
# File 'lib/aws-sdk-core/api/docs/param_formatter.rb', line 14

def format
  if @shape_ref && @shape_ref.shape.member_names.count > 0
    ref_value(@shape_ref, '', [])
  else
    ''
  end
end