From 20391db9c279a6486d27d1d5cb5f334a1767e298 Mon Sep 17 00:00:00 2001
From: John Resig <jeresig@gmail.com>
Date: Fri, 8 Sep 2006 10:44:32 +0000
Subject: [PATCH] Touched up the docs and formatting.

---
 src/dimensions/dimensions.js |  153 ++++++++++++++++++++++--------------------
 1 file changed, 81 insertions(+), 72 deletions(-)

diff --git a/src/dimensions/dimensions.js b/src/dimensions/dimensions.js
index cc24820..a821696 100644
--- a/src/dimensions/dimensions.js
+++ b/src/dimensions/dimensions.js
@@ -6,160 +6,169 @@
 /**
  * Returns the css height value for the first matched element.
  * If used on document, returns the document's height (innerHeight)
- * If used on window, returns the viewports (window's) height
+ * If used on window, returns the viewport's (window) height
  *
  * @example $("#testdiv").height()
- * @result [ 200px ]
+ * @result "200px"
+ *
+ * @example $(document).height();
+ * @result 800
+ *
+ * @example $(window).height();
+ * @result 400
  * 
  * @name height
- * @type jQuery
+ * @type Object
  * @cat Dimensions
  */
 $.fn.height = function() {
-
-	if(this.get(0) == window) {
-		if (self.innerHeight) return self.innerHeight;	
-		else if (document.documentElement && document.documentElement.clientHeight) return document.documentElement.clientHeight;
-		else if (document.body) return document.body.clientHeight;
-	}
+	if ( this.get(0) == window )
+		return self.innerHeight ||
+			jQuery.boxModel && document.documentElement.clientHeight ||
+			document.body.clientHeight;
 	
-	if(this.get(0) == document) {
-
-		var test1 = document.body.scrollHeight;
-		var test2 = document.body.offsetHeight;
-		if (test1 > test2) return document.body.scrollHeight;
-		else return document.body.offsetHeight;		
-	}
+	if ( this.get(0) == document )
+		return Math.max( document.body.scrollHeight, document.body.offsetHeight );
 	
 	return this.css("height");
-}
+};
+
 /**
  * Returns the css width value for the first matched element.
  * If used on document, returns the document's width (innerWidth)
- * If used on window, returns the viewports (window's) width
+ * If used on window, returns the viewport's (window) width
  *
  * @example $("#testdiv").width()
- * @result [ 200px ]
+ * @result "200px"
+ *
+ * @example $(document).width();
+ * @result 800
+ *
+ * @example $(window).width();
+ * @result 400
  * 
  * @name width
- * @type jQuery
+ * @type Object
  * @cat Dimensions
  */
 $.fn.width = function() {
-
-	if(this.get(0) == window) {
-		if (self.innerWidth) return self.innerWidth;	
-		else if (document.documentElement && document.documentElement.clientWidth) return document.documentElement.clientWidth;
-		else if (document.body) return document.body.clientWidth;
-	}
+	if ( this.get(0) == window )
+		return self.innerWidth ||
+			jQuery.boxModel && document.documentElement.clientWidth ||
+			document.body.clientWidth;
 	
-	if(this.get(0) == document) {
-
-		var test1 = document.body.scrollWidth;
-		var test2 = document.body.offsetWidth;
-		if (test1 > test2) return document.body.scrollWidth;
-		else return document.body.offsetWidth;		
-	}
+	if ( this.get(0) == document )
+		return Math.max( document.body.scrollWidth, document.body.offsetWidth );
 	
 	return this.css("width");
-}
+};
+
 /**
  * Returns the inner height value (without border) for the first matched element.
  * If used on document, returns the document's height (innerHeight)
- * If used on window, returns the viewports (window's) height
+ * If used on window, returns the viewport's (window) height
  *
  * @example $("#testdiv").innerHeight()
- * @result [ 800px ]
+ * @result 800
  * 
  * @name innerHeight
- * @type jQuery
+ * @type Number
  * @cat Dimensions
  */
 $.fn.innerHeight = function() {
-	if(this.get(0) == window || this.get(0) == document) return this.height();
-	return this.get(0).offsetHeight - (parseInt(this.css("borderTop")) + parseInt(this.css("borderBottom")));
-}
+	return this.get(0) == window || this.get(0) == document ?
+		this.height() :
+		this.get(0).offsetHeight - parseInt(this.css("borderTop")) - parseInt(this.css("borderBottom"));
+};
+
 /**
  * Returns the inner width value (without border) for the first matched element.
  * If used on document, returns the document's Width (innerWidth)
- * If used on window, returns the viewports (window's) width
+ * If used on window, returns the viewport's (window) width
  *
  * @example $("#testdiv").innerWidth()
- * @result [ 1000px ]
+ * @result 1000
  * 
  * @name innerWidth
- * @type jQuery
+ * @type Number
  * @cat Dimensions
  */
 $.fn.innerWidth = function() {
-	if(this.get(0) == window || this.get(0) == document) return this.width();
-	return this.get(0).offsetWidth - (parseInt(this.css("borderLeft")) + parseInt(this.css("borderRight")));
-}
+	return this.get(0) == window || this.get(0) == document ?
+		this.width() :
+		this.get(0).offsetWidth - parseInt(this.css("borderLeft")) - parseInt(this.css("borderRight"));
+};
+
 /**
  * Returns the outer height value (including border) for the first matched element.
  * Cannot be used on document or window.
  *
  * @example $("#testdiv").outerHeight()
- * @result [ 1000px ]
+ * @result 1000
  * 
  * @name outerHeight
- * @type jQuery
+ * @type Number
  * @cat Dimensions
  */
 $.fn.outerHeight = function() {
-	if(this.get(0) == window || this.get(0) == document) return 0;
-	return this.get(0).offsetHeight;	
-}
+	return this.get(0) == window || this.get(0) == document ?
+		this.height() :
+		this.get(0).offsetHeight;	
+};
+
 /**
  * Returns the outer width value (including border) for the first matched element.
  * Cannot be used on document or window.
  *
  * @example $("#testdiv").outerWidth()
- * @result [ 1000px ]
+ * @result 1000
  * 
  * @name outerWidth
- * @type jQuery
+ * @type Number
  * @cat Dimensions
  */
 $.fn.outerWidth = function() {
-	if(this.get(0) == window || this.get(0) == document) return 0;
-	return this.get(0).offsetWidth;	
-}
+	return this.get(0) == window || this.get(0) == document ?
+		this.width() :
+		this.get(0).offsetWidth;	
+};
+
 /**
  * Returns how many pixels the user has scrolled to the right (scrollLeft).
  * Works on containers with overflow: auto and window/document.
  *
  * @example $("#testdiv").scrollLeft()
- * @result [ 100px ]
+ * @result 100
  * 
  * @name scrollLeft
- * @type jQuery
+ * @type Number
  * @cat Dimensions
  */
 $.fn.scrollLeft = function() {
-	if(this.get(0) == window || this.get(0) == document) {
-	if (self.pageXOffset) return self.pageXOffset;
-	else if (document.documentElement && document.documentElement.scrollLeft) return document.documentElement.scrollLeft;
-	else if (document.body) return document.body.scrollLeft;
-	}
+	if ( this.get(0) == window || this.get(0) == document )
+		return self.pageXOffset ||
+			jQuery.boxModel && document.documentElement.scrollLeft ||
+			document.body.scrollLeft;
+	
 	return this.get(0).scrollLeft;
-}
+};
+
 /**
  * Returns how many pixels the user has scrolled to the bottom (scrollTop).
  * Works on containers with overflow: auto and window/document.
  *
  * @example $("#testdiv").scrollTop()
- * @result [ 100px ]
+ * @result 100
  * 
  * @name scrollTop
- * @type jQuery
+ * @type Number
  * @cat Dimensions
  */
 $.fn.scrollTop = function() {
-	if(this.get(0) == window || this.get(0) == document) {
-	if (self.pageYOffset) return self.pageYOffset;
-	else if (document.documentElement && document.documentElement.scrollTop) return document.documentElement.scrollTop;
-	else if (document.body) return document.body.scrollTop;
-	}	
+	if ( this.get(0) == window || this.get(0) == document )
+		return self.pageYOffset ||
+			jQuery.boxModel && document.documentElement.scrollTop ||
+			document.body.scrollTop;
+
 	return this.get(0).scrollTop;
-}
\ No newline at end of file
+};
\ No newline at end of file
-- 
1.7.10.4