Class: Aws::Api::Docs::OperationDocumenter Private

Inherits:
Object
  • Object
show all
Includes:
Utils, Seahorse::Model
Defined in:
lib/aws-sdk-core/api/docs/operation_documenter.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(service_name, namespace, uid) ⇒ OperationDocumenter

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 OperationDocumenter.



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

def initialize(service_name, namespace, uid)
  @service_name = service_name
  @namespace = namespace
  @optname = 'options'
  @uid = uid
end

Instance Method Details

#document(method_name, operation) ⇒ Object

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. 



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/aws-sdk-core/api/docs/operation_documenter.rb', line 18

def document(method_name, operation)
  m = YARD::CodeObjects::MethodObject.new(@namespace, method_name)
  m.group = 'API Operations'
  m.scope = :instance
  m.parameters << [@optname, '{}']
  m.docstring = operation.documentation
  tags(method_name, operation).each do |tag|
    m.add_tag(tag)
  end
end