1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00

more doc consistency fixes

This commit is contained in:
Wesley Beary 2009-07-04 10:20:37 -07:00
parent 71225d2d06
commit d40995dd17

View file

@ -39,6 +39,7 @@ module Fog
# Acquire an elastic IP address. # Acquire an elastic IP address.
# #
# ==== Returns # ==== Returns
# response::
# body<~Hash>:: # body<~Hash>::
# :public_ip<~String>:: The acquired address # :public_ip<~String>:: The acquired address
def allocate_address def allocate_address
@ -50,13 +51,14 @@ module Fog
# Create an EBS volume # Create an EBS volume
# #
# ==== Parameters # ==== Parameters
# availability_zone<~String>:: availability zone to create volume in # :availability_zone<~String>::
# size<~Integer>:: Size in GiBs for volume. Must be between 1 and 1024. # availability zone to create volume in
# snapshot_id<~String>:: Optional, snapshot to create volume from # :size<~Integer>:: Size in GiBs for volume. Must be between 1 and 1024.
# :snapshot_id<~String>:: Optional, snapshot to create volume from
# #
# ==== Returns # ==== Returns
# response:: # response::
# body<~Hash>:: # :body<~Hash>::
# :volume_id<~String>:: Reference to volume # :volume_id<~String>:: Reference to volume
# :size<~Integer>:: Size in GiBs for volume # :size<~Integer>:: Size in GiBs for volume
# :status<~String>:: State of volume # :status<~String>:: State of volume
@ -94,11 +96,12 @@ module Fog
# public_ips<~Array>:: List of ips to describe, defaults to all # public_ips<~Array>:: List of ips to describe, defaults to all
# #
# ==== Returns # ==== Returns
# body<~Hash>:: # response:
# :request_id<~String>:: Id of request # body<~Hash>::
# :address_set<~Array>:: Addresses # :request_id<~String>:: Id of request
# :instance_id<~String>:: instance for ip address # :address_set<~Array>:: Addresses
# :public_ip<~String>:: ip address for instance # :instance_id<~String>:: instance for ip address
# :public_ip<~String>:: ip address for instance
def describe_addresses(public_ips = []) def describe_addresses(public_ips = [])
params = indexed_params('PublicIp', public_ips) params = indexed_params('PublicIp', public_ips)
request({ request({
@ -116,16 +119,17 @@ module Fog
# :owner<~String>:: Only return images belonging to owner. # :owner<~String>:: Only return images belonging to owner.
# #
# ==== Returns # ==== Returns
# body<~Hash>:: # response::
# :request_id<~String>:: Id of request # body<~Hash>::
# :image_set<~Array>:: Images # :request_id<~String>:: Id of request
# :architecture<~String>:: Architecture of the image # :image_set<~Array>:: Images
# :image_id<~String>:: Id of the image # :architecture<~String>:: Architecture of the image
# :image_location<~String>:: Location of the image # :image_id<~String>:: Id of the image
# :image_owner_id<~String>:: Id of the owner of the image # :image_location<~String>:: Location of the image
# :image_state<~String>:: State of the image # :image_owner_id<~String>:: Id of the owner of the image
# :image_type<~String>:: Type of the image # :image_state<~String>:: State of the image
# :is_public<~Boolean:: Whether or not the image is public # :image_type<~String>:: Type of the image
# :is_public<~Boolean:: Whether or not the image is public
def describe_images(options = {}) def describe_images(options = {})
params = {} params = {}
if options[:image_id] if options[:image_id]