Class: Aws::Api::Documenter Private

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-core/api/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.

Defined Under Namespace

Classes: Tabulator

Instance Method Summary collapse

Constructor Details

#initialize(svc_module, docs_path) ⇒ Documenter

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



7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/aws-sdk-core/api/documenter.rb', line 7

def initialize(svc_module, docs_path)
  @svc_module = svc_module
  @svc_name = svc_module.name.split('::').last
  @client_class = svc_module.const_get(:Client)
  Aws::Api::Docstrings.apply(@client_class, docs_path)
  @api = @client_class.api
  @full_name = @api.metadata('serviceFullName')
  @error_names = @api.operations.map {|_,o| o.errors.map(&:name) }
  @error_names = @error_names.flatten.uniq.sort
  @namespace = YARD::Registry['Aws']
end

Instance Method Details

#apply ⇒ 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. 



19
20
21
22
23
 
# File 'lib/aws-sdk-core/api/documenter.rb', line 19

def apply
  document_service
  document_client
  document_errors
end