unique_identifier.rb in esp_sdk-2.6.0

- old
+ new
@@ -3,60 +3,65 @@
     class UniqueIdentifier < ESP::Resource
       self.prefix += "suppressions/alert/:alert_id/"
       # Not Implemented. You cannot search for Suppression::UniqueIdentifier.
       #
       # Regular ARELlike methods are disabled.  Use the ESP::Suppression object to search suppressions.
+      #
+      # @return [void]
       def self.where(*)
         fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled.  Use the ESP::Suppression object to search suppressions'
       end
 
       # Not Implemented. You cannot search for Suppression::UniqueIdentifier.
       #
       # Regular ARELlike methods are disabled.  Use the ESP::Suppression object to search suppressions.
+      #
+      # @return [void]
       def self.find(*)
         fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled.  Use the ESP::Suppression object to search suppressions'
       end
 
       # Not Implemented. You cannot update a Suppression::UniqueIdentifier.
+      #
+      # @return [void]
       def update
         fail ESP::NotImplementedError
       end
 
       # Not Implemented. You cannot destroy a Suppression::UniqueIdentifier.
+      #
+      # @return [void]
       def destroy
         fail ESP::NotImplementedError
       end
 
-      # :singleton-method: create
-      # Create a suppression for a unique identifier.
+      # @!method self.create(attributes = {})
+      #   Create a suppression for a unique identifier.
       #
-      # Pass an +alert_id+, the suppression will be created based on that alert.
+      #   Pass an +alert_id+, the suppression will be created based on that alert.
       #
-      # :call-seq:
-      #   create(attributes={})
+      #   *call-seq* -> +super.create(attributes={})+
       #
-      # ==== Parameter
+      #   @param attributes [Hash] Required hash of unique identifier suppression attributes.
+      #     ==== Attributes
       #
-      # +attributes+ | Required | A hash of unique identifier suppression attributes
-      #
-      # ==== Attributes
-      #
-      # See {API documentation}[http://api-docs.evident.io?ruby#suppression-unique-identifier-create] for valid arguments
-      #
-      # ==== Example
-      #   create(alert_id: 5, reason: 'My very good reason for creating this suppression')
+      #     See {API documentation}[http://api-docs.evident.io?ruby#suppression-unique-identifier-create] for valid arguments
+      #   @return [ESP::Suppression::UniqueIdentifier>]
+      #   @example
+      #     create(alert_id: 5, reason: 'My very good reason for creating this suppression')
 
-      # :method: save
-      # Create a suppression for a unique identifier.
+      # @!method save
+      #   Create a suppression for a unique identifier.
       #
-      # Set an +alert_id+, the suppression will be created based on that alert.
+      #   Set an +alert_id+, the suppression will be created based on that alert.
       #
-      # ==== Attributes
+      #   ==== Attributes
       #
-      # See {API documentation}[http://api-docs.evident.io?ruby#suppression-unique-identifier-create] for valid arguments
+      #   See {API documentation}[http://api-docs.evident.io?ruby#suppression-unique-identifier-create] for valid arguments
       #
-      # ==== Example
-      #   suppression = new(alert_id: 5, reason: 'My very good reason for creating this suppression')
-      #   suppression.save
+      #   @return [Boolean]
+      #   @example
+      #     suppression = new(alert_id: 5, reason: 'My very good reason for creating this suppression')
+      #     suppression.save
     end
   end
 end