opal/browser/dom/element/position.rb in opal-browser-0.2.0.beta1 vs opal/browser/dom/element/position.rb in opal-browser-0.2.0

@@ -1,13 +1,17 @@
 module Browser; module DOM; class Element < Node
 
 class Position
+  attr_reader :element
+
+  # @private
   def initialize(element)
     @element = element
     @native  = element.to_n
   end
 
+  # @private
   def get
     offset        = @element.offset
     position      = offset.get
     parent        = offset.parent
     parent_offset = Browser::Position.new(0, 0)
@@ -19,17 +23,22 @@
 
       parent_offset.x += parent.style['border-top-width'].to_i
       parent_offset.y += parent.style['border-left-width'].to_i
     end
 
-    Browser::Position.new(position.x - parent_offset.x - @element.style['margin-left'].to_i,
-                          position.y - parent_offset.y - @element.style['margin-top'].to_i)
+    Browser::Position.new(
+      position.x - parent_offset.x - @element.style['margin-left'].to_i,
+      position.y - parent_offset.y - @element.style['margin-top'].to_i)
   end
 
+  # @!attribute [r] x
+  # @return [Integer] the position of the element on the x axis
   def x
     get.x
   end
 
+  # @!attribute [r] y
+  # @return [Integer] the position of the element on the y axis
   def y
     get.y
   end
 end