lib/rcap/cap_1_0/point.rb in rcap-1.3.0 vs lib/rcap/cap_1_0/point.rb in rcap-1.3.1

@@ -9,46 +9,60 @@
       MAX_LONGITUDE = 180
       MIN_LONGITUDE = -180
       MAX_LATTITUDE = 90
       MIN_LATTITUDE = -90
 
+      # @return [Numeric]
       attr_accessor( :lattitude )
+      # @return [Numeric]
       attr_accessor( :longitude )
 
       validates_numericality_of( :lattitude, :longitude )
       validates_inclusion_of( :lattitude, :in => MIN_LATTITUDE..MAX_LATTITUDE )
       validates_inclusion_of( :longitude, :in => MIN_LONGITUDE..MAX_LONGITUDE)
 
+      # @param [Hash] attributes
+      # @option attributes [Numeric] :lattitude
+      # @option attributes [Numeric] :longitude
       def initialize( attributes = {} )
         @lattitude = attributes[ :lattitude ]
         @longitude = attributes[ :longitude ]
       end
 
       # Returns a string representation of the point of the form
       #  lattitude,longitude
+      #
+      # @return [String]
       def to_s
-        "#{ self.lattitude },#{ self.longitude }"
+        "#{ @lattitude },#{ @longitude }"
       end
 
-      def inspect # :nodoc:
+      # @return [String]
+      def inspect 
         '('+self.to_s+')'
       end
 
       # Two points are equivalent if they have the same lattitude and longitude
+      #
+      # @param [Point] other
+      # @return [true, false]
       def ==( other )
-        [ self.lattitude, self.longitude ] == [ other.lattitude, other.longitude ]
+        [ @lattitude, @longitude ] == [ other.lattitude, other.longitude ]
       end
 
-      LATTITUDE_KEY = 'lattitude'  # :nodoc:
-      LONGITUDE_KEY = 'longitude'  # :nodoc:
+      LATTITUDE_KEY = 'lattitude'  
+      LONGITUDE_KEY = 'longitude'  
 
-      def to_h # :nodoc:
+      # @return [Hash]
+      def to_h 
         RCAP.attribute_values_to_hash(
-          [ LATTITUDE_KEY, self.lattitude ],
-          [ LONGITUDE_KEY, self.longitude ])
+          [ LATTITUDE_KEY, @lattitude ],
+          [ LONGITUDE_KEY, @longitude ])
       end
 
-      def self.from_h( point_hash ) # :nodoc:
+      # @param [Hash] point_hash
+      # @return [Point]
+      def self.from_h( point_hash ) 
         self.new( :lattitude => point_hash[ LATTITUDE_KEY ], :longitude => point_hash[ LONGITUDE_KEY ])
       end
     end
   end
 end