Ensure all sl_dynamic_attr items are doc'ed as methods and include the force_update argument in their doc.

Author: cmarkle

lib/softlayer/Account.rb

@@ -62,7 +62,7 @@ class Account < SoftLayer::ModelBase
     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)
@@ -109,6 +114,8 @@ class Account < SoftLayer::ModelBase
 
     ##
     # 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/NetworkMessageDelivery.rb

@@ -37,7 +37,9 @@ class NetworkMessageDelivery < ModelBase
     sl_attr :username
 
     ##
-    # The message delivery type description of a network message delivery account.
+    # Retrieve the message delivery type description of a network message delivery account.
+    # :call-seq:
+    #   description(force_update=false)
     sl_dynamic_attr :description do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -51,7 +53,9 @@ class NetworkMessageDelivery < ModelBase
     end
 
     ##
-    # The message delivery type name of a network message delivery account.
+    # Retrieve the message delivery type name of a network message delivery account.
+    # :call-seq:
+    #   name(force_update=false)
     sl_dynamic_attr :name do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -65,7 +69,9 @@ class NetworkMessageDelivery < ModelBase
     end
 
     ##
-    # The vendor name for a network message delivery account.
+    # Retrieve the vendor name for a network message delivery account.
+    # :call-seq:
+    #   vendor(force_update=false)
     sl_dynamic_attr :vendor do |resource|
       resource.should_update? do
         #only retrieved once per instance

lib/softlayer/NetworkService.rb

@@ -36,7 +36,9 @@ class NetworkService < ModelBase
     sl_attr :ssh_username, 'sshUsername'
 
     ##
-    # Returns the datacenter that this network service resource is available in
+    # Retrieve the datacenter that this network service resource is available in
+    # :call-seq:
+    #   datacenter(force_update=false)
     sl_dynamic_attr :datacenter do |resource|
       resource.should_update? do
         #only retrieved once per instance

lib/softlayer/NetworkStorage.rb

@@ -55,7 +55,9 @@ class NetworkStorage < ModelBase
     sl_attr :username
 
     ##
-    # Other usernames and passwords associated with a Storage volume.
+    # Retrieve other usernames and passwords associated with a Storage volume.
+    # :call-seq:
+    #   account_password(force_update=false)
     sl_dynamic_attr :account_password do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -70,6 +72,8 @@ class NetworkStorage < ModelBase
 
     ##
     # A Storage volume's access credentials.
+    # :call-seq:
+    #   credentials(force_update=false)
     sl_dynamic_attr :credentials do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -83,6 +87,8 @@ class NetworkStorage < ModelBase
 
     ##
     # The network resource a Storage service is connected to.
+    # :call-seq:
+    #   service_resource(force_update=false)
     sl_dynamic_attr :service_resource do |resource|
       resource.should_update? do
         #only retrieved once per instance

lib/softlayer/NetworkStorageAllowedHost.rb

@@ -15,7 +15,9 @@ class NetworkStorageAllowedHost < ModelBase
     sl_attr :name
 
     ##
-    # The NetworkStorageGroup instances assigned to this host
+    # Retrieve the NetworkStorageGroup instances assigned to this host
+    # :call-seq:
+    #   assigned_groups(force_update=false)
     sl_dynamic_attr :assigned_groups do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -29,7 +31,9 @@ class NetworkStorageAllowedHost < ModelBase
     end
 
     ##
-    # The NetworkStorage instances assigned to this host
+    # Retrieve the NetworkStorage instances assigned to this host
+    # :call-seq:
+    #   assigned_volumes(force_update=false)
     sl_dynamic_attr :assigned_volumes do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -43,7 +47,9 @@ class NetworkStorageAllowedHost < ModelBase
     end
 
     ##
-    # The NetworkStorageCredential instance used to access NetworkStorage for this host
+    # Retrieve the NetworkStorageCredential instance used to access NetworkStorage for this host
+    # :call-seq:
+    #   credential(force_update=false)
     sl_dynamic_attr :credential do |resource|
       resource.should_update? do
         #only retrieved once per instance

lib/softlayer/NetworkStorageGroup.rb

@@ -25,7 +25,9 @@ class NetworkStorageGroup < ModelBase
     sl_attr :modified, 'modifyDate'
 
     ##
-    # The SoftLayer_Account which owns this group.
+    # Retrieve the SoftLayer_Account which owns this group.
+    # :call-seq:
+    #   account(force_update=false)
     sl_dynamic_attr :account do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -39,7 +41,9 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The allowed hosts list for this group.
+    # Retrieve the allowed hosts list for this group.
+    # :call-seq:
+    #   allowed_hosts(force_update=false)
     sl_dynamic_attr :allowed_hosts do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -53,7 +57,9 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The network storage volumes this group is attached to.
+    # Retrieve the network storage volumes this group is attached to.
+    # :call-seq:
+    #   attached_volumes(force_update=false)
     sl_dynamic_attr :attached_volumes do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -67,7 +73,9 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The IP address for for SoftLayer_Network_Storage_Allowed_Host objects within this group.
+    # Retrieve the IP address for for SoftLayer_Network_Storage_Allowed_Host objects within this group.
+    # :call-seq:
+    #   ip_address(force_update=false)
     sl_dynamic_attr :ip_address do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -81,7 +89,10 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The description of the SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
+    # Retrieve the description of the SoftLayer_Network_Storage_OS_Type 
+    # Operating System designation that this group was created for.
+    # :call-seq:
+    #   os_description(force_update=false)
     sl_dynamic_attr :os_description do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -95,7 +106,10 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The name of the SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for.
+    # Retrieve the name of the SoftLayer_Network_Storage_OS_Type 
+    # Operating System designation that this group was created for.
+    # :call-seq:
+    #   os_name(force_update=false)
     sl_dynamic_attr :os_name do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -109,7 +123,9 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The network resource this group is created on.
+    # Retrieve the network resource this group is created on.
+    # :call-seq:
+    #   service_resource(force_update=false)
     sl_dynamic_attr :service_resource do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -123,7 +139,9 @@ class NetworkStorageGroup < ModelBase
     end
 
     ##
-    # The name of the SoftLayer_Network_Storage_Group_Type which describes this group.
+    # Retrieve the name of the SoftLayer_Network_Storage_Group_Type which describes this group.
+    # :call-seq:
+    #   type(force_update=false)
     sl_dynamic_attr :type do |resource|
       resource.should_update? do
         #only retrieved once per instance

lib/softlayer/ProductItemCategory.rb

@@ -62,6 +62,10 @@ class ProductItemCategory < ModelBase
     # The name of a category is a friendly, readable string
     sl_attr :name
 
+    ##
+    # Retrieve the product item configuration information
+    # :call-seq:
+    #   configuration_options(force_update=false)
     sl_dynamic_attr :configuration_options do |config_opts|
       config_opts.should_update? do
         # only retrieved once per instance

lib/softlayer/ProductPackage.rb

@@ -48,8 +48,9 @@ class ProductPackage < ModelBase
     sl_attr :available_locations, 'availableLocations'
 
     ##
-    # The set of product categories needed to make an order for this product package.
-    #
+    # Retrieve the set of product categories needed to make an order for this product package.
+    # :call-seq:
+    #   configuration(force_update=false)
     sl_dynamic_attr :configuration do |resource|
       resource.should_update? do
         # only retrieved once per instance
@@ -98,8 +99,9 @@ class ProductPackage < ModelBase
     end # configuration
 
     ##
-    # The full set of product categories contained in the package
-    #
+    # Retrieve the full set of product categories contained in the package
+    # :call-seq:
+    #   categories(force_update=false)
     sl_dynamic_attr :categories do |resource|
       resource.should_update? do
         @categories == nil

lib/softlayer/Server.rb

@@ -53,6 +53,10 @@ class Server  < SoftLayer::ModelBase
     # Notes about these server (for use by the customer)
     sl_attr :notes
 
+    ##
+    # Retrieve the primary network component
+    # :call-seq:
+    #   primary_network_component(force_update=false)
     sl_dynamic_attr :primary_network_component do |primary_component|
       primary_component.should_update? do
         return @primary_network_component == nil
@@ -65,8 +69,9 @@ class Server  < SoftLayer::ModelBase
     end
 
     ##
-    # :attr_reader:
-    # All software installed on current server
+    # Retrieve all software installed on current server
+    # :call-seq:
+    #   software(force_update=false)
     sl_dynamic_attr :software do |software|
       software.should_update? do
         @software == nil