Merge pull request #98 from cmarkle/rdoc-fix

Fix incorrect rdoc for simple case where sl_attr is specified with two args

Author: SLsthompson

lib/softlayer/Account.rb

@@ -58,11 +58,11 @@ class Account < SoftLayer::ModelBase
 
     ##
     # :attr_reader:
-    # The office phone nubmer listed for the primary contact
+    # The office phone number listed for the primary contact
     sl_attr :officePhone
 
     ##
-    # The Bare Metal Servers (physical hardware) associated with the
+    # Retrieve the Bare Metal Servers (physical hardware) associated with the
     # account. Unless you force these to update, they will be refreshed every
     # five minutes.
     # :call-seq:
@@ -82,6 +82,8 @@ class Account < SoftLayer::ModelBase
     ##
     # Retrieve an account's master EVault user. This is only used when an account
     # has an EVault service.
+    # :call-seq:
+    #   evault_master_users(force_update=false)
     sl_dynamic_attr :evault_master_users do |evault_users|
       evault_users.should_update? do
         @evault_master_users == nil
@@ -94,7 +96,10 @@ class Account < SoftLayer::ModelBase
     end
 
     ##
-    # Retrieve an account's image templates
+    # Retrieve an account's image templates. Unless you force 
+    # these to update, they will be refreshed every five minutes
+    # :call-seq:
+    #   image_templates(force_update=false)
     sl_dynamic_attr :image_templates do |image_templates|
       image_templates.should_update? do
         @last_image_template_update ||= Time.at(0)
@@ -108,7 +113,9 @@ class Account < SoftLayer::ModelBase
     end
 
     ##
-    # Retrieve an account's network message delivery acounts.
+    # Retrieve an account's network message delivery accounts.
+    # :call-seq:
+    #   network_message_delivery_accounts(force_update=false)
     sl_dynamic_attr :network_message_delivery_accounts do |net_msg_deliv_accts|
       net_msg_deliv_accts.should_update? do
         @network_message_delivery_accounts == nil
@@ -122,6 +129,8 @@ class Account < SoftLayer::ModelBase
 
     ##
     # Retrieve an account's network storage groups.
+    # :call-seq:
+    #   network_storage_groups(force_update=false)
     sl_dynamic_attr :network_storage_groups do |net_stor_groups|
       net_stor_groups.should_update? do
         @network_storage_groups == nil
@@ -134,7 +143,10 @@ class Account < SoftLayer::ModelBase
     end
 
     ##
-    # Retrieve an account's open tickets
+    # Retrieve an account's open tickets. Unless you force these 
+    # to update, they will be refreshed every five minutes
+    # :call-seq:
+    #   open_tickets(force_update=false)
     sl_dynamic_attr :open_tickets do |open_tickets|
       open_tickets.should_update? do
         @last_open_tickets_update ||= Time.at(0)
@@ -150,6 +162,8 @@ class Account < SoftLayer::ModelBase
 
     ##
     # Retrieve an account's portal users.
+    # :call-seq:
+    #   users(force_update=false)
     sl_dynamic_attr :users do |users|
       users.should_update? do
         @users == nil
@@ -162,7 +176,10 @@ class Account < SoftLayer::ModelBase
     end
 
     ##
-    # Retrieve an account's virtual disk images
+    # Retrieve an account's virtual disk images. Unless you force 
+    # these to update, they will be refreshed every five minutes
+    # :call-seq:
+    #   virtual_disk_images(force_update=false)
     sl_dynamic_attr :virtual_disk_images do |virtual_disk_images|
       virtual_disk_images.should_update? do
         @last_virtual_disk_images_update ||= Time.at(0)
@@ -177,7 +194,7 @@ class Account < SoftLayer::ModelBase
     end
 
     ##
-    # The virtual servers (aka. CCIs or Virtual_Guests) associated with the
+    # Retrieve the virtual servers (aka. CCIs or Virtual_Guests) associated with the
     # account. Unless you force these to update, they will be refreshed every
     # five minutes.
     # :call-seq:

lib/softlayer/AccountPassword.rb

@@ -32,6 +32,8 @@ class AccountPassword < ModelBase
 
     ##
     # A description of the use for the account username/password combination.
+    # :call-seq:
+    #   description(force_update=false)
     sl_dynamic_attr :description do |resource|
       resource.should_update? do
         #only retrieved once per instance

lib/softlayer/BareMetalServer.rb

@@ -9,7 +9,7 @@
 module SoftLayer
   #
   # This class represents a Bare Metal Server, a hardware server in contrast to a virtual machine,
-  # in the SoftLayer Environment. It corresponds rougly to the +SoftLayer_Hardware+ and
+  # in the SoftLayer Environment. It corresponds roughly to the +SoftLayer_Hardware+ and
   # +SoftLayer_Hardware_Server+ services in the SoftLayer API
   #
   # http://sldn.softlayer.com/reference/datatypes/SoftLayer_Hardware
@@ -23,7 +23,7 @@ class BareMetalServer < Server
     # a Bare Metal Instance is physical, hardware server that is is provisioned to
     # match a profile with characteristics similar to a Virtual Server
     #
-    # This is an important distincition in rare cases, like cancelling the server.
+    # This is an important distinction in rare cases, like cancelling the server.
     #
     def bare_metal_instance?
       if has_sl_property?(:bareMetalInstanceFlag)
@@ -65,7 +65,7 @@ def remote_management_accounts
     # Returns the typical Service used to work with this Server
     # For Bare Metal Servers that is +SoftLayer_Hardware+ though in some special cases
     # you may have to use +SoftLayer_Hardware_Server+ as a type or service.  That
-    # service object is available thorugh the hardware_server_service method
+    # service object is available through the hardware_server_service method
     def service
       return softlayer_client[:Hardware_Server].object_with_id(self.id)
     end
@@ -146,7 +146,7 @@ def firewall_port_speed
     end
 
     ##
-    # Retrive the bare metal server with the given server ID from the
+    # Retrieve the bare metal server with the given server ID from the
     # SoftLayer API
     #
     # The options parameter should contain:

lib/softlayer/BareMetalServerOrder.rb

@@ -93,7 +93,7 @@ class BareMetalServerOrder
     attr_accessor :max_port_speed
 
     ##
-    # Create a new order that works thorugh the given client connection
+    # Create a new order that works through the given client connection
     def initialize (client = nil)
       @softlayer_client = client || Client.default_client
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !@softlayer_client
@@ -195,7 +195,7 @@ def self.disk_options(client = nil)
     end
 
     ##
-    # Returns a list of the valid :os_refrence_codes
+    # Returns a list of the valid :os_reference_codes
     def self.os_reference_code_options(client = nil)
       create_object_options(client)['operatingSystems'].collect { |os_spec| os_spec['template']['operatingSystemReferenceCode'] }.uniq.sort!
     end

lib/softlayer/BareMetalServerOrder_Package.rb

@@ -42,14 +42,14 @@ class BareMetalServerOrder_Package < Server
     # The domain of the server being created (i.e. 'softlayer.com' is the domain of sldn.softlayer.com)
     attr_accessor :domain
 
-    # The value of this property should be a hash. The keys of the hash are ProdcutItemCategory
+    # The value of this property should be a hash. The keys of the hash are ProductItemCategory
     # codes (like 'os' and 'ram') while the values may be Integers or Objects. The Integer values
     # should be the +id+ of a +SoftLayer_Product_Item_Price+ representing the configuration option
     # chosen for that category. Objects must respond to the +price_id+ message and return an integer
     # that is the +id+ of a +SoftLayer_Product_Item_Price+. Instances of the ProductConfigurationOption
     # class behave this way.
     #
-    # At a minimum, the configuation_options should include entries for each of the categories
+    # At a minimum, the configuration_options should include entries for each of the categories
     # required by the package (i.e. those returned from ProductPackage#required_categories)
     attr_accessor :configuration_options
 

lib/softlayer/Client.rb

@@ -6,7 +6,7 @@
 
 module SoftLayer
   # A client is responsible for storing authentication information for API calls and
-  # it serves as a centeral repository for the Service instances that call into the
+  # it serves as a central repository for the Service instances that call into the
   # network API.
   #
   # When you create a client, you pass in hash arguments specifying how the client
@@ -21,16 +21,16 @@ module SoftLayer
   # class to provide the missing information.  Please see that class for details.
   #
   class Client
-    # A username passed as authentication for each request. Cannot be emtpy or nil.
+    # A username passed as authentication for each request. Cannot be empty or nil.
     attr_reader :username
 
-    # An API key passed as part of the authentication of each request. Cannot be emtpy or nil.
+    # An API key passed as part of the authentication of each request. Cannot be empty or nil.
     attr_reader :api_key
 
-    # The base URL for requests that are passed to the server. Cannot be emtpy or nil.
+    # The base URL for requests that are passed to the server. Cannot be empty or nil.
     attr_reader :endpoint_url
 
-    # A string passsed as the value for the User-Agent header when requests are sent to SoftLayer API.
+    # A string passed as the value for the User-Agent header when requests are sent to SoftLayer API.
     attr_accessor :user_agent
 
     # An integer value (in seconds). The number of seconds to wait for HTTP requests to the network API
@@ -63,7 +63,7 @@ def self.default_client=(new_default)
     # Clients are built with a number of settings:
     # * <b>+:username+</b> - The username of the account you wish to access through the API
     # * <b>+:api_key+</b> - The API key used to authenticate the user with the API
-    # * <b>+:enpoint_url+</b> - The API endpoint the client should connect to.  This defaults to API_PUBLIC_ENDPOINT
+    # * <b>+:endpoint_url+</b> - The API endpoint the client should connect to.  This defaults to API_PUBLIC_ENDPOINT
     # * <b>+:user_agent+</b> - A string that is passed along as the user agent when the client sends requests to the server
     # * <b>+:timeout+</b> - An integer number of seconds to wait until network requests time out.  Corresponds to the network_timeout property of the client
     #
@@ -92,7 +92,7 @@ def initialize(options = {})
 
       raise "A SoftLayer Client requires a username" if !@username || @username.empty?
       raise "A SoftLayer Client requires an api_key" if !@api_key || @api_key.empty?
-      raise "A SoftLayer Clietn requires an enpoint URL" if !@endpoint_url || @endpoint_url.empty?
+      raise "A SoftLayer Client requires an endpoint URL" if !@endpoint_url || @endpoint_url.empty?
     end
 
     # return a hash of the authentication headers for the client

lib/softlayer/Config.rb

@@ -11,7 +11,7 @@ module SoftLayer
   # The SoftLayer Config class is responsible for providing the key information
   # the library needs to communicate with the network SoftLayer API. Those three crucial
   # pieces of information are the Username, the API Key, and the endpoint_url. This information
-  # is collected in a hash with the keys `:username`, `:api_key`, and `:endpoint_url` repsectively.
+  # is collected in a hash with the keys `:username`, `:api_key`, and `:endpoint_url` respectively.
   #
   # The routine used to retrieve this information from a Config object is Config.client_settings
   #
@@ -45,7 +45,7 @@ module SoftLayer
   # = Environment Variables
   #
   # The config class will search the environment variables SL_USERNAME and SL_API_KEY for
-  # the username and API key respectively. The endpoint_url may not be set thorugh
+  # the username and API key respectively. The endpoint_url may not be set through
   # environment variables.
   #
   # = Global Variables

lib/softlayer/Datacenter.rb

@@ -17,7 +17,15 @@ module SoftLayer
   # represent.
 
   class Datacenter < SoftLayer::ModelBase
+
+    ##
+    # :attr_reader:
+    # A short location description
     sl_attr :name
+
+    ##
+    # :attr_reader: long_name
+    # A longer location description
     sl_attr :long_name, "longName"
 
     ##
@@ -30,7 +38,7 @@ def self.datacenter_named(name, client = nil)
     # Return a list of all the datacenters
     #
     # If the client parameter is not provided, the routine
-    # will try to use Client::defult_client.  If no client
+    # will try to use Client::default_client.  If no client
     # can be found, the routine will raise an exception
     #
     # This routine will only retrieve the list of datacenters from
@@ -50,4 +58,4 @@ def self.datacenters(client = nil, force_reload = false)
       @@data_centers
     end
   end
-end
+end

lib/softlayer/DynamicAttribute.rb

@@ -7,7 +7,7 @@
 module SoftLayer
 
   ##
-  # This module is inteneded to be used by classes in the SoftLayer
+  # This module is intended to be used by classes in the SoftLayer
   # object model. It creates a small DSL for creating attributes
   # that update themselves dynamically (usually by making requests
   # to the SoftLayer API)

lib/softlayer/ImageTemplate.rb

@@ -9,7 +9,7 @@ module SoftLayer
   ##
   # A Virtual Server Image Template.
   #
-  # This class rougly corresponds to the unwieldily named
+  # This class roughly corresponds to the unwieldy named
   # +SoftLayer_Virtual_Guest_Block_Device_Template_Group+
   # service:
   #
@@ -23,12 +23,12 @@ class ImageTemplate < SoftLayer::ModelBase
     sl_attr :name
 
     ##
-    # :attr_reader:
+    # :attr_reader: notes
     # The notes, if any, that are attached to the template. Can be nil.
     sl_attr :notes, "note"
 
     ##
-    # :attr_reader:
+    # :attr_reader: global_id
     # The universally unique identifier (if any) for the template. Can be nil.
     sl_attr :global_id, 'globalIdentifier'
 
@@ -91,7 +91,7 @@ def datacenters
     # appear in this array! The list given must be comprehensive.
     #
     # The available_datacenters call returns a list of the values that are valid
-    # whithin this array.
+    # within this array.
     def datacenters=(datacenters_array)
       datacenter_data = datacenters_array.collect do |datacenter|
         { "id" => datacenter.id }
@@ -160,7 +160,7 @@ def delete!
     end
 
     ##
-    # Repeatedly poll the netwokr API until transactions related to this image
+    # Repeatedly poll the network API until transactions related to this image
     # template are finished
     #
     # A template is not 'ready' until all the transactions on the template
@@ -210,7 +210,7 @@ def softlayer_properties(object_mask = nil)
     #
     # Additional options that may be provided:
     # * <b>+:name+</b>      (string/array) - Return templates with the given name
-    # * <b>+:global_id+</b> (string/array) - Return templates with the given global identfier
+    # * <b>+:global_id+</b> (string/array) - Return templates with the given global identifier
     # * <b>+:tags+</b>      (string/array) - Return templates with the tags
     def self.find_private_templates(options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -267,7 +267,7 @@ def self.find_private_templates(options_hash = {})
     #
     # Additional options that may be provided:
     # * <b>+:name+</b>      (string/array) - Return templates with the given name
-    # * <b>+:global_id+</b> (string/array) - Return templates with the given global identfier
+    # * <b>+:global_id+</b> (string/array) - Return templates with the given global identifier
     # * <b>+:tags+</b>      (string/array) - Return templates with the tags
     def self.find_public_templates(options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -313,7 +313,7 @@ def self.find_public_templates(options_hash = {})
     end
 
     ##
-    # Retrive the Image Template with the given ID
+    # Retrieve the Image Template with the given ID
     # (Note! This is the service ID, not the globalIdentifier!)
     #
     # The options parameter should contain: