Class: Aws::Api::Docs::DocstringProvider Private
- Inherits:
-
Object
- Object
- Aws::Api::Docs::DocstringProvider
- 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
-
#initialize(docstrings) ⇒ DocstringProvider
constructor
private
A new instance of DocstringProvider.
- #operation_docs(operation_name) ⇒ String? private
- #shape_docs(shape_name) ⇒ String? private
- #shape_ref_docs(shape_name, target) ⇒ String? private
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.
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.
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.
25 26 27 28 29 30 31 |
# 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] clean(ref_docs) else shape_docs(shape_name) end end |