innerHeight(): Add documentation for innerHeight as setter

kswedberg · kswedberg · commit 9d78f2d17b30 · 2014-08-19T22:42:44.000-04:00
diff --git a/entries/innerHeight.xml b/entries/innerHeight.xml
@@ -1,4 +1,7 @@
 <?xml version="1.0"?>
+<entries>
+  <desc>Get the current computed inner height (including padding but not border) for the first element in the set of matched elements or set the inner height of every matched element.</desc>
+
 <entry type="method" name="innerHeight" return="Number">
   <title>.innerHeight()</title>
   <signature>
@@ -36,3 +39,69 @@ $( "p:last" ).text( "innerHeight:" + p.innerHeight() );
   <category slug="manipulation/style-properties"/>
   <category slug="version/1.2.6"/>
 </entry>
+
+<entry type="method" name="innerHeight" return="jQuery">
+<signature>
+  <added>1.8.0</added>
+  <argument name="value">
+  <type name="String"/>
+  <type name="Number"/>
+  <desc>A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string).</desc>
+  </argument>
+</signature>
+<signature>
+  <added>1.8.0</added>
+  <argument name="function" type="Function">
+    <argument name="index" type="Integer" />
+    <argument name="width" type="Number" />
+    <return>
+      <type name="String"/>
+      <type name="Number"/>
+    </return>
+    <desc>A function returning the inner height (including padding but not border) to set. Receives the index position of the element in the set and the old inner height as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
+  </argument>
+</signature>
+<desc>Set the CSS inner height of each element in the set of matched elements.</desc>
+<longdesc>
+  <p>When calling <code>.innerHeight("value")</code>, the value can be either a string (number and unit) or a number. If only a number is provided for the value, jQuery assumes a pixel unit. If a string is provided, however, any valid CSS measurement may be used for the height (such as <code>100px</code>, <code>50%</code>, or <code>auto</code>). Note that in modern browsers, the CSS height property does not include padding, border, or margin, unless the <code>box-sizing</code> CSS property is used.</p>
+  <p>If no explicit unit is specified (like "em" or "%") then "px" is assumed.</p>
+</longdesc>
+<example>
+  <desc>Change the inner height of each div the first time it is clicked (and change its color).</desc>
+  <code><![CDATA[
+var modHeight = 70;
+$( "div" ).one( "click", function() {
+  $( this ).innerHeight( modHeight ).addClass( "mod" );
+  modHeight -= 8;
+});
+]]></code>
+  <css><![CDATA[
+div {
+  width: 60px;
+  padding: 10px;
+  height: 70px;
+  float: left;
+  margin: 5px;
+  background: red;
+  cursor: pointer;
+}
+.mod {
+  background: blue;
+  cursor: default;
+}
+]]></css>
+  <html><![CDATA[
+<div>d</div>
+<div>d</div>
+<div>d</div>
+<div>d</div>
+<div>d</div>
+]]></html>
+</example>
+<category slug="css"/>
+<category slug="dimensions"/>
+<category slug="manipulation/style-properties"/>
+<category slug="version/1.8"/>
+</entry>
+
+</entries>
