Class: Aws::Resources::Documenter::HasOperationDocumenter
Instance Attribute Summary
#api_request, #api_request_name, #api_request_params, #builder, #called_operation, #operation_name, #resource_class, #resource_class_name, #source, #target_resource_class, #target_resource_class_name, #yard_class
Instance Method Summary
collapse
#initialize, #method_object
Instance Method Details
#argument? ⇒ Boolean
39
40
41
|
# File 'lib/aws-sdk-resources/documenter/has_operation_documenter.rb', line 39
def argument?
@operation.arity > 0
end
|
#argument_name ⇒ Object
51
52
53
54
55
56
|
# 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? ⇒ Boolean
43
44
45
|
# File 'lib/aws-sdk-resources/documenter/has_operation_documenter.rb', line 43
def can_return_nil?
data_member
end
|
#data_member ⇒ Object
47
48
49
|
# File 'lib/aws-sdk-resources/documenter/has_operation_documenter.rb', line 47
def data_member
builder.sources.find { |s| BuilderSources::DataMember === s }
end
|
#parameters ⇒ Object
16
17
18
19
20
21
22
|
# File 'lib/aws-sdk-resources/documenter/has_operation_documenter.rb', line 16
def parameters
if argument?
[[argument_name, nil]]
else
[]
end
end
|
#plural? ⇒ Boolean
35
36
37
|
# File 'lib/aws-sdk-resources/documenter/has_operation_documenter.rb', line 35
def plural?
@operation.builder.plural?
end
|
#return_tag ⇒ Object
6
7
8
9
10
11
12
13
14
|
# 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
|
24
25
26
27
28
29
30
31
32
33
|
# 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
|