security_group_rule.rb in yao-0.14.0

- old
+ new

@@ -1,10 +1,12 @@
 require 'yao/resources/security_group'
 module Yao::Resources
   class SecurityGroupRule < Base
     friendly_attributes :ethertype
 
+    # @param _name [Symbol]
+    # @param _guard_name [Symbol]
     def self.define_attribute_with_guard(_name, _guard_name)
       name = _name.to_s
       guard_name = _guard_name.to_s
       define_method name do
         self[name] || self[guard_name]
@@ -14,33 +16,41 @@
     define_attribute_with_guard :port_range_max, :from_port
     define_attribute_with_guard :port_range_min, :to_port
     define_attribute_with_guard :protocol, :ip_protocol
     define_attribute_with_guard :security_group_id, :parent_group_id
 
+    # @return [Yao::Resources::SecurityGroup]
     def security_group
       SecurityGroup.find(security_group_id)
     end
 
+    # if port_range_max == port_range_min
+    # @return [Integer]
+    # else
+    # @return [Range]
     def port
       if port_range_max == port_range_min
         port_range_max
       else
         port_range
       end
     end
 
+    # @return [String]
     def remote_ip_cidr
       if cidr = self["remote_ip_prefix"]
         cidr
       elsif ip_range = self["ip_range"]
         ip_range["cidr"]
       end
     end
 
+    # @return [Range]
     def port_range
       port_range_max..port_range_min
     end
 
+    # @return [Yao::Resources::SecurityGroup]
     def remote_group
       return nil if self["remote_group_id"].nil? && (self["group"].nil? || self["group"].empty?)
 
       SecurityGroup.new(
         {"id" => self["remote_group_id"]}.merge(self["group"] || {})