lib/tms_client/resource/command.rb in tms_client-0.1.0 vs lib/tms_client/resource/command.rb in tms_client-0.1.1
- old
+ new
@@ -1,15 +1,13 @@
module TMS #:nodoc:
# A command is a combination of behavior and parameters that should be executed
# when an incoming SMS message matches the associated Keyword.
#
- # ==== Attributes
+ # @attr name [String] The name of the command. This will default to the command_type if not supplied.
+ # @attr command_type [String] The type of this command. A list of valid types can be found by querying the CommandType list.
+ # @attr params [Hash] A Hash of string/string pairs used as configuration for this command.
#
- # * +name+ - The name of the command. This will default to the command_type if not supplied.
- # * +command_type+ - The type of this command. A list of valid types can be found by querying the CommandType list.
- # * +params+ - A Hash of string/string pairs used as configuration for this command.
- #
- # === Examples
+ # @example
# command = keyword.commands.build(:name => "subscribe to news", :command_type => "dcm_subscribe", :dcm_account_code => "NEWS", :dcm_topic_codes => "NEWS_1, NEWS_2")
# command.post
# command.dcm_topic_codes += ", NEWS_5"
# command.put
# command.delete
\ No newline at end of file