From adf80ad1b34eb48d006410aa97ff838818e83146 Mon Sep 17 00:00:00 2001
From: tjcrowder <tj@crowdersoftware.com>
Date: Fri, 9 Oct 2009 17:10:13 +0100
Subject: [PATCH] doc: Merged/updated old docs for
 Element.cumulativeScrollOffset, clarified units, added example.

---
 src/dom/dom.js | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/dom/dom.js b/src/dom/dom.js
index 6806c52..84c144d 100644
--- a/src/dom/dom.js
+++ b/src/dom/dom.js
@@ -1232,11 +1232,25 @@ Element.Methods = {
   /**
    *  Element.cumulativeScrollOffset(@element) -> Array
    *
-   *  Calculates the cumulative scroll offset of an element in nested
-   *  scrolling containers.
+   *  Calculates the cumulative scroll offset (in pixels) of an element in
+   *  nested scrolling containers.
    *
    *  Returns an array in the form of `[leftValue, topValue]`. Also accessible
    *  as properties: `{ left: leftValue, top: topValue }`.
+   *
+   *  ##### Example
+   *
+   *  Assuming the div `foo` is at scroll offset (0,257), then:
+   *
+   *      var offset = $('foo').cumulativeOffset();
+   *      offset[0];
+   *      // -> 0
+   *      offset[1];
+   *      // -> 257
+   *      offset.left;
+   *      // -> 0
+   *      offset.top;
+   *      // -> 257
   **/
   cumulativeScrollOffset: function(element) {
     var valueT = 0, valueL = 0;