From 22e5f7197372b6a697b877b192da69177d30baac Mon Sep 17 00:00:00 2001 From: Paul Thornthwaite Date: Thu, 2 May 2013 12:22:05 +0100 Subject: [PATCH] [Docs] Fixes assorted yardoc tagging issues This fixes some incorrect tag names and type/name ordering --- .../requests/cdn/delete_streaming_distribution.rb | 4 ++-- lib/fog/aws/requests/cdn/put_distribution_config.rb | 6 +++--- .../aws/requests/cloud_formation/update_stack.rb | 6 +++--- .../requests/cloud_formation/validate_template.rb | 10 +++++----- .../aws/requests/storage/list_multipart_uploads.rb | 13 ++++++------- lib/fog/aws/requests/storage/put_object_acl.rb | 12 ++++++------ .../requests/storage/list_multipart_uploads.rb | 11 +++++------ lib/fog/rackspace/cdn.rb | 2 +- lib/fog/xenserver/models/compute/network.rb | 4 ++-- 9 files changed, 33 insertions(+), 35 deletions(-) diff --git a/lib/fog/aws/requests/cdn/delete_streaming_distribution.rb b/lib/fog/aws/requests/cdn/delete_streaming_distribution.rb index e5def6876..be51da072 100644 --- a/lib/fog/aws/requests/cdn/delete_streaming_distribution.rb +++ b/lib/fog/aws/requests/cdn/delete_streaming_distribution.rb @@ -5,8 +5,8 @@ module Fog # Delete a streaming distribution from CloudFront. # - # @param distribution_id [String] Id of distribution to delete. - # @parma etag [String] Etag of that distribution from earlier get or put + # @param [String] distribution_id Id of distribution to delete. + # @param [String] etag Etag of that distribution from earlier get or put # # @see http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/DeleteStreamingDistribution.html diff --git a/lib/fog/aws/requests/cdn/put_distribution_config.rb b/lib/fog/aws/requests/cdn/put_distribution_config.rb index 6794b7351..806d8c1fa 100644 --- a/lib/fog/aws/requests/cdn/put_distribution_config.rb +++ b/lib/fog/aws/requests/cdn/put_distribution_config.rb @@ -7,9 +7,9 @@ module Fog # 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. - # + # # REQUIRED: # * S3Origin [Hash]: # * DNSName [String] - origin to associate with distribution, ie 'mybucket.s3.amazonaws.com'. @@ -117,4 +117,4 @@ module Fog end end -end \ No newline at end of file +end diff --git a/lib/fog/aws/requests/cloud_formation/update_stack.rb b/lib/fog/aws/requests/cloud_formation/update_stack.rb index 0950b6a8c..521d457f9 100644 --- a/lib/fog/aws/requests/cloud_formation/update_stack.rb +++ b/lib/fog/aws/requests/cloud_formation/update_stack.rb @@ -7,8 +7,8 @@ module Fog # Update a stack. # - # @parm stack_name [String] Name of the stack to update. - # @parm options [Hash] + # @param [String] stack_name Name of the stack to update. + # @param [Hash] options # * TemplateBody [String] Structure containing the template body. # or (one of the two Template parameters is required) # * TemplateURL [String] URL of file containing the template body. @@ -20,7 +20,7 @@ module Fog # * StackId [String] - Id of the stack being updated # # @see http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html - + # def update_stack(stack_name, options = {}) params = { 'StackName' => stack_name, diff --git a/lib/fog/aws/requests/cloud_formation/validate_template.rb b/lib/fog/aws/requests/cloud_formation/validate_template.rb index 2a59b98f1..2ef5ed579 100644 --- a/lib/fog/aws/requests/cloud_formation/validate_template.rb +++ b/lib/fog/aws/requests/cloud_formation/validate_template.rb @@ -7,17 +7,17 @@ module Fog # Describe stacks. # - # @para options [Hash] - # @option options TemplateBody [String] template structure - # @option options TemplateURL [String] template url + # @param [Hash] options + # @option options [String] TemplateBody template structure + # @option options [String] TemplateURL template url # # @return [Excon::Response] # * body [Hash]: # * Description [String] - description found within the template # * 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 = {}) request({ 'Action' => 'ValidateTemplate', diff --git a/lib/fog/aws/requests/storage/list_multipart_uploads.rb b/lib/fog/aws/requests/storage/list_multipart_uploads.rb index 93c35f6c2..bd078dcdc 100644 --- a/lib/fog/aws/requests/storage/list_multipart_uploads.rb +++ b/lib/fog/aws/requests/storage/list_multipart_uploads.rb @@ -7,16 +7,15 @@ module Fog # List multipart uploads for a bucket # - # @param bucket_name [String] Name of bucket to list multipart uploads for - # @param upload_id [String] upload id to list objects for - # @param options [Hash] config arguments for list. Defaults to {}. - # @option options key-marker[String] limits parts to only those that appear lexicographically after this key. - # @option options max-uploads [Integer] limits number of uploads returned - # @option options upload-id-marker [String] limits uploads to only those that appear lexicographically after this upload id. + # @param [String] bucket_name Name of bucket to list multipart uploads for + # @param [Hash] options config arguments for list. Defaults to {}. + # @option options [String] key-marker limits parts to only those that appear lexicographically after this key. + # @option options [Integer] max-uploads limits number of uploads returned + # @option options [String] upload-id-marker limits uploads to only those that appear lexicographically after this upload id. # # @return [Excon::Response] response: # * 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 # * KeyMarker [String] first key in list, only upload ids after this lexographically will appear # * MaxUploads [Integer] Maximum results to return diff --git a/lib/fog/aws/requests/storage/put_object_acl.rb b/lib/fog/aws/requests/storage/put_object_acl.rb index 7eff3db5e..03b714026 100644 --- a/lib/fog/aws/requests/storage/put_object_acl.rb +++ b/lib/fog/aws/requests/storage/put_object_acl.rb @@ -7,9 +7,9 @@ module Fog # Change access control list for an S3 object # - # @param bucket_name [String] name of bucket to modify - # @param object_name [String] name of object to get access control list for - # @param acl [Hash]: + # @param [String] bucket_name name of bucket to modify + # @param [String] object_name name of object to get access control list for + # @param [Hash] acl # * Owner [Hash] # * ID [String] id of owner # * DisplayName [String] display name of owner @@ -22,9 +22,9 @@ module Fog # or # * URI [String] URI of group to grant access for # * 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 options [Hash] - # @option options versionId [String] specify a particular version to retrieve + # @param [String] acl Permissions, must be in ['private', 'public-read', 'public-read-write', 'authenticated-read'] + # @param [Hash] options + # @option options [String] versionId specify a particular version to retrieve # # @see http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html diff --git a/lib/fog/internet_archive/requests/storage/list_multipart_uploads.rb b/lib/fog/internet_archive/requests/storage/list_multipart_uploads.rb index 8fe83fe18..65dab3c13 100644 --- a/lib/fog/internet_archive/requests/storage/list_multipart_uploads.rb +++ b/lib/fog/internet_archive/requests/storage/list_multipart_uploads.rb @@ -7,12 +7,11 @@ module Fog # List multipart uploads for a bucket # - # @param bucket_name [String] Name of bucket to list multipart uploads for - # @param upload_id [String] upload id to list objects for - # @param options [Hash] config arguments for list. Defaults to {}. - # @option options key-marker[String] limits parts to only those that appear lexicographically after this key. - # @option options max-uploads [Integer] limits number of uploads returned - # @option options upload-id-marker [String] limits uploads to only those that appear lexicographically after this upload id. + # @param [String] bucket_name Name of bucket to list multipart uploads for + # @param [Hash] options config arguments for list. Defaults to {}. + # @option options [String] key-marker limits parts to only those that appear lexicographically after this key. + # @option options [Integer] max-uploads limits number of uploads returned + # @option options [String] upload-id-marker limits uploads to only those that appear lexicographically after this upload id. # # @return [Excon::Response] response: # * body [Hash]: diff --git a/lib/fog/rackspace/cdn.rb b/lib/fog/rackspace/cdn.rb index a77dde286..3179499ae 100644 --- a/lib/fog/rackspace/cdn.rb +++ b/lib/fog/rackspace/cdn.rb @@ -36,7 +36,7 @@ module Fog end # 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. # @return [Hash] hash containing urls for published container # @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 diff --git a/lib/fog/xenserver/models/compute/network.rb b/lib/fog/xenserver/models/compute/network.rb index b79afb1cb..452185f92 100644 --- a/lib/fog/xenserver/models/compute/network.rb +++ b/lib/fog/xenserver/models/compute/network.rb @@ -59,7 +59,7 @@ module Fog # net = service.networks.create :name => 'foonet', # :description => 'test network' # - # @returns [Boolean] + # @return [Boolean] # def save requires :name @@ -77,7 +77,7 @@ module Fog # net = service.networks.find { |net| net.name == 'foonet' } # net.destroy # - # @returns [Boolean] + # @return [Boolean] # def destroy requires :reference