Class: Aws::Api::Docs::ClientTypeDocumenter Private
- Inherits:
-
Object
- Object
- Aws::Api::Docs::ClientTypeDocumenter
- Includes:
- Utils, Seahorse::Model, Seahorse::Model::Shapes
- Defined in:
- lib/aws-sdk-core/api/docs/client_type_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
- #document(api, shape) ⇒ Object private
-
#initialize(namespace) ⇒ ClientTypeDocumenter
constructor
private
A new instance of ClientTypeDocumenter.
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(namespace) ⇒ ClientTypeDocumenter
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 ClientTypeDocumenter.
11 12 13 |
# File 'lib/aws-sdk-core/api/docs/client_type_documenter.rb', line 11 def initialize(namespace) @namespace = namespace end |
Instance Method Details
#document(api, shape) ⇒ 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.
17 18 19 20 21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-core/api/docs/client_type_documenter.rb', line 17 def document(api, shape) yard_class = YARD::CodeObjects::ClassObject.new(@namespace, shape.name) yard_class.superclass = 'Struct' yard_class.docstring = docstring(api, shape) (api, shape).each do |tag| yard_class.add_tag(tag) end shape.members.each do |member_name, ref| document_struct_member(yard_class, member_name, ref) end end |