mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
[Docs] Fixes assorted yardoc tagging issues
This fixes some incorrect tag names and type/name ordering
This commit is contained in:
parent
9035c3abf6
commit
22e5f71973
9 changed files with 33 additions and 35 deletions
|
@ -5,8 +5,8 @@ module Fog
|
||||||
|
|
||||||
# Delete a streaming distribution from CloudFront.
|
# Delete a streaming distribution from CloudFront.
|
||||||
#
|
#
|
||||||
# @param distribution_id [String] Id of distribution to delete.
|
# @param [String] distribution_id Id of distribution to delete.
|
||||||
# @parma etag [String] Etag of that distribution from earlier get or put
|
# @param [String] etag Etag of that distribution from earlier get or put
|
||||||
#
|
#
|
||||||
# @see http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DeleteStreamingDistribution.html
|
# @see http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DeleteStreamingDistribution.html
|
||||||
|
|
||||||
|
|
|
@ -7,9 +7,9 @@ module Fog
|
||||||
|
|
||||||
# Update a distribution in CloudFront.
|
# Update a distribution in CloudFront.
|
||||||
#
|
#
|
||||||
# @parm distribution_id [String] Id of distribution to update config for.
|
# @param distribution_id [String] Id of distribution to update config for.
|
||||||
# @param options [Hash] Config for distribution.
|
# @param options [Hash] Config for distribution.
|
||||||
#
|
#
|
||||||
# REQUIRED:
|
# REQUIRED:
|
||||||
# * S3Origin [Hash]:
|
# * S3Origin [Hash]:
|
||||||
# * DNSName [String] - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'.
|
# * DNSName [String] - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'.
|
||||||
|
@ -117,4 +117,4 @@ module Fog
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -7,8 +7,8 @@ module Fog
|
||||||
|
|
||||||
# Update a stack.
|
# Update a stack.
|
||||||
#
|
#
|
||||||
# @parm stack_name [String] Name of the stack to update.
|
# @param [String] stack_name Name of the stack to update.
|
||||||
# @parm options [Hash]
|
# @param [Hash] options
|
||||||
# * TemplateBody [String] Structure containing the template body.
|
# * TemplateBody [String] Structure containing the template body.
|
||||||
# or (one of the two Template parameters is required)
|
# or (one of the two Template parameters is required)
|
||||||
# * TemplateURL [String] URL of file containing the template body.
|
# * TemplateURL [String] URL of file containing the template body.
|
||||||
|
@ -20,7 +20,7 @@ module Fog
|
||||||
# * StackId [String] - Id of the stack being updated
|
# * StackId [String] - Id of the stack being updated
|
||||||
#
|
#
|
||||||
# @see http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html
|
# @see http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html
|
||||||
|
#
|
||||||
def update_stack(stack_name, options = {})
|
def update_stack(stack_name, options = {})
|
||||||
params = {
|
params = {
|
||||||
'StackName' => stack_name,
|
'StackName' => stack_name,
|
||||||
|
|
|
@ -7,17 +7,17 @@ module Fog
|
||||||
|
|
||||||
# Describe stacks.
|
# Describe stacks.
|
||||||
#
|
#
|
||||||
# @para options [Hash]
|
# @param [Hash] options
|
||||||
# @option options TemplateBody [String] template structure
|
# @option options [String] TemplateBody template structure
|
||||||
# @option options TemplateURL [String] template url
|
# @option options [String] TemplateURL template url
|
||||||
#
|
#
|
||||||
# @return [Excon::Response]
|
# @return [Excon::Response]
|
||||||
# * body [Hash]:
|
# * body [Hash]:
|
||||||
# * Description [String] - description found within the template
|
# * Description [String] - description found within the template
|
||||||
# * Parameters [String] - list of template parameter structures
|
# * Parameters [String] - list of template parameter structures
|
||||||
#
|
#
|
||||||
# http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ValidateTemplate.html
|
# @see http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ValidateTemplate.html
|
||||||
|
#
|
||||||
def validate_template(options = {})
|
def validate_template(options = {})
|
||||||
request({
|
request({
|
||||||
'Action' => 'ValidateTemplate',
|
'Action' => 'ValidateTemplate',
|
||||||
|
|
|
@ -7,16 +7,15 @@ module Fog
|
||||||
|
|
||||||
# List multipart uploads for a bucket
|
# List multipart uploads for a bucket
|
||||||
#
|
#
|
||||||
# @param bucket_name [String] Name of bucket to list multipart uploads for
|
# @param [String] bucket_name Name of bucket to list multipart uploads for
|
||||||
# @param upload_id [String] upload id to list objects for
|
# @param [Hash] options config arguments for list. Defaults to {}.
|
||||||
# @param options [Hash] config arguments for list. Defaults to {}.
|
# @option options [String] key-marker limits parts to only those that appear lexicographically after this key.
|
||||||
# @option options key-marker[String] limits parts to only those that appear lexicographically after this key.
|
# @option options [Integer] max-uploads limits number of uploads returned
|
||||||
# @option options max-uploads [Integer] limits number of uploads returned
|
# @option options [String] upload-id-marker limits uploads to only those that appear lexicographically after this upload id.
|
||||||
# @option options upload-id-marker [String] limits uploads to only those that appear lexicographically after this upload id.
|
|
||||||
#
|
#
|
||||||
# @return [Excon::Response] response:
|
# @return [Excon::Response] response:
|
||||||
# * body [Hash]:
|
# * body [Hash]:
|
||||||
# * Bucket [string] Bucket where the multipart upload was initiated
|
# * Bucket [String] Bucket where the multipart upload was initiated
|
||||||
# * IsTruncated [Boolean] Whether or not the listing is truncated
|
# * IsTruncated [Boolean] Whether or not the listing is truncated
|
||||||
# * KeyMarker [String] first key in list, only upload ids after this lexographically will appear
|
# * KeyMarker [String] first key in list, only upload ids after this lexographically will appear
|
||||||
# * MaxUploads [Integer] Maximum results to return
|
# * MaxUploads [Integer] Maximum results to return
|
||||||
|
|
|
@ -7,9 +7,9 @@ module Fog
|
||||||
|
|
||||||
# Change access control list for an S3 object
|
# Change access control list for an S3 object
|
||||||
#
|
#
|
||||||
# @param bucket_name [String] name of bucket to modify
|
# @param [String] bucket_name name of bucket to modify
|
||||||
# @param object_name [String] name of object to get access control list for
|
# @param [String] object_name name of object to get access control list for
|
||||||
# @param acl [Hash]:
|
# @param [Hash] acl
|
||||||
# * Owner [Hash]
|
# * Owner [Hash]
|
||||||
# * ID [String] id of owner
|
# * ID [String] id of owner
|
||||||
# * DisplayName [String] display name of owner
|
# * DisplayName [String] display name of owner
|
||||||
|
@ -22,9 +22,9 @@ module Fog
|
||||||
# or
|
# or
|
||||||
# * URI [String] URI of group to grant access for
|
# * URI [String] URI of group to grant access for
|
||||||
# * Permission [String] Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
|
# * Permission [String] Permission, in [FULL_CONTROL, WRITE, WRITE_ACP, READ, READ_ACP]
|
||||||
# @param acl [String] Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
|
# @param [String] acl Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read']
|
||||||
# @param options [Hash]
|
# @param [Hash] options
|
||||||
# @option options versionId [String] specify a particular version to retrieve
|
# @option options [String] versionId specify a particular version to retrieve
|
||||||
#
|
#
|
||||||
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html
|
# @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html
|
||||||
|
|
||||||
|
|
|
@ -7,12 +7,11 @@ module Fog
|
||||||
|
|
||||||
# List multipart uploads for a bucket
|
# List multipart uploads for a bucket
|
||||||
#
|
#
|
||||||
# @param bucket_name [String] Name of bucket to list multipart uploads for
|
# @param [String] bucket_name Name of bucket to list multipart uploads for
|
||||||
# @param upload_id [String] upload id to list objects for
|
# @param [Hash] options config arguments for list. Defaults to {}.
|
||||||
# @param options [Hash] config arguments for list. Defaults to {}.
|
# @option options [String] key-marker limits parts to only those that appear lexicographically after this key.
|
||||||
# @option options key-marker[String] limits parts to only those that appear lexicographically after this key.
|
# @option options [Integer] max-uploads limits number of uploads returned
|
||||||
# @option options max-uploads [Integer] limits number of uploads returned
|
# @option options [String] upload-id-marker limits uploads to only those that appear lexicographically after this upload id.
|
||||||
# @option options upload-id-marker [String] limits uploads to only those that appear lexicographically after this upload id.
|
|
||||||
#
|
#
|
||||||
# @return [Excon::Response] response:
|
# @return [Excon::Response] response:
|
||||||
# * body [Hash]:
|
# * body [Hash]:
|
||||||
|
|
|
@ -36,7 +36,7 @@ module Fog
|
||||||
end
|
end
|
||||||
|
|
||||||
# Publish container to CDN
|
# Publish container to CDN
|
||||||
# @param [Fog::Storage::Rackspace::Directory] directory to publish
|
# @param [Fog::Storage::Rackspace::Directory] container directory to publish
|
||||||
# @param [Boolean] publish If true directory is published. If false directory is unpublished.
|
# @param [Boolean] publish If true directory is published. If false directory is unpublished.
|
||||||
# @return [Hash] hash containing urls for published container
|
# @return [Hash] hash containing urls for published container
|
||||||
# @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
|
# @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
|
||||||
|
|
|
@ -59,7 +59,7 @@ module Fog
|
||||||
# net = service.networks.create :name => 'foonet',
|
# net = service.networks.create :name => 'foonet',
|
||||||
# :description => 'test network'
|
# :description => 'test network'
|
||||||
#
|
#
|
||||||
# @returns [Boolean]
|
# @return [Boolean]
|
||||||
#
|
#
|
||||||
def save
|
def save
|
||||||
requires :name
|
requires :name
|
||||||
|
@ -77,7 +77,7 @@ module Fog
|
||||||
# net = service.networks.find { |net| net.name == 'foonet' }
|
# net = service.networks.find { |net| net.name == 'foonet' }
|
||||||
# net.destroy
|
# net.destroy
|
||||||
#
|
#
|
||||||
# @returns [Boolean]
|
# @return [Boolean]
|
||||||
#
|
#
|
||||||
def destroy
|
def destroy
|
||||||
requires :reference
|
requires :reference
|
||||||
|
|
Loading…
Reference in a new issue