class Aws::Resources::Documenter::HasOperationDocumenter

Public Instance Methods

argument?() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 39
def argument?
  @operation.arity > 0
end
argument_name() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 51
def argument_name
  argument = builder.sources.find do |source|
    BuilderSources::Argument === source
  end
  argument.target.to_s
end
can_return_nil?() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 43
def can_return_nil?
  data_member
end
data_member() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 47
def data_member
  builder.sources.find { |s| BuilderSources::DataMember === s }
end
parameters() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 16
def parameters
  if argument?
    [[argument_name, nil]]
  else
    []
  end
end
plural?() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 35
def plural?
  @operation.builder.plural?
end
return_tag() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 6
def return_tag
  if plural?
    type = "Array<#{target_resource_class_name}>"
  else
    type = target_resource_class_name
  end
  type += ',nil' if can_return_nil?
  tag("@return [#{type}]")
end
tags() click to toggle source
# File lib/aws-sdk-resources/documenter/has_operation_documenter.rb, line 24
def tags
  tags = super
  if argument?
    tag = "@param [String] #{argument_name} "
    tag << "The {#{target_resource_class_name}##{argument_name}} "
    tag << "identifier."
    tags += YARD::DocstringParser.new.parse(tag).to_docstring.tags
  end
  tags
end