Class: Aws::Api::Docs::DocstringProvider Private

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

Constructor Details

#initialize(docstrings) ⇒ DocstringProvider

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



6
7
8
 
# File 'lib/aws-sdk-core/api/docs/docstring_provider.rb', line 6

def initialize(docstrings)
  @docstrings = docstrings
end

Instance Method Details

#operation_docs(operation_name) ⇒ String?

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.

Parameters:

  • operation_name (String)

Returns:

  • (String, nil) 


12
13
14
 
# File 'lib/aws-sdk-core/api/docs/docstring_provider.rb', line 12

def operation_docs(operation_name)
  clean(@docstrings['operations'][operation_name])
end

#shape_docs(shape_name) ⇒ String?

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.

Parameters:

  • shape_name (String)

Returns:

  • (String, nil) 


18
19
20
 
# File 'lib/aws-sdk-core/api/docs/docstring_provider.rb', line 18

def shape_docs(shape_name)
  clean(shape(shape_name)['base'])
end

#shape_ref_docs(shape_name, target) ⇒ String?

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.

Parameters:

  • shape_name (String)
  • target (String)

Returns:

  • (String, nil) 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/aws-sdk-core/api/docs/docstring_provider.rb', line 25

def shape_ref_docs(shape_name, target)
  if ref_docs = shape(shape_name)['refs'][target]
    docs = clean(ref_docs)
    # Running through kramdown to catch unclosed tags that
    # break the client doc pages, see Aws::RDS::Client
    # for an example.
    begin
      require 'kramdown'
      Kramdown::Document.new(docs, input: 'html').to_kramdown.strip
    rescue LoadError
      docs
    end
  else
    shape_docs(shape_name)
  end
end