class Aws::Resources::Documenter

Public Class Methods

apply_customizations() click to toggle source
# File lib/aws-sdk-resources/documenter.rb, line 18
def apply_customizations
  document_s3_object_upload_file_additional_options
end

Private Class Methods

document_s3_object_upload_file_additional_options() click to toggle source
# File lib/aws-sdk-resources/documenter.rb, line 24
def document_s3_object_upload_file_additional_options
  input = Aws::S3::Client.api.operation(:create_multipart_upload).input
  opts = input.shape.member_names - [:bucket, :key]
  tags = opts.map do |opt|
    ref = input.shape.member(opt)
    type = case ref.shape
    when StructureShape then 'Structure'
    when ListShape then 'Array'
    when MapShape then 'Hash'
    when StringShape then 'String'
    when IntegerShape then 'Integer'
    when FloatShape then 'Float'
    when BooleanShape then 'Boolean'
    when TimestampShape then 'Time'
    when BlobShape then 'IO'
    else
      raise "unhandled shape class `#{ref.shape.class.name}'"
    end
    docs = ref.documentation || ref.shape.documentation
    "@option options [#{type}] :#{opt} #{docs}"
  end
  tags = YARD::DocstringParser.new.parse(tags).to_docstring.tags
  m = YARD::Registry['Aws::S3::Object#upload_file']
  tags.each { |tag| m.add_tag(tag) }
end