#17 adding doc for crop and adjust functions

Gruntfile.js

@@ -24,8 +24,8 @@ module.exports = function(grunt) {
               src: ['*.js', 'README.md'],
               options: {
                   destination : 'docs',
-                     template : "node_modules/ink-docstrap/template",
-                    configure : "jsdoc.conf.json"
+                  template : "node_modules/ink-docstrap/template",
+                  configure : "jsdoc.conf.json"
               }
             }
         }

docs/Thumb.html

@@ -241,6 +241,330 @@ <h3 class="subsection-title">Methods</h3>
 
         <dl>
 
+<hr>
+<dt>
+    <h4 class="name" id="adjust"><span class="type-signature"></span>adjust(adjust)</h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        <p>Adjust the image to the width ('wi') or height ('he') if one<br>of them are 0 setted. Usually setted with <a href="Thumb.html#crop">crop</a>.</p>
+    </div>
+
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+
+        <th>Name</th>
+
+
+        <th>Type</th>
+
+
+
+
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+
+
+        <tr>
+
+                <td class="name"><code>adjust</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">string</span>
+
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last"><p>adjust value should be 'wi' (width) or 'he' (height)</p></td>
+        </tr>
+
+
+    </tbody>
+</table>
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
+	<dd class="tag-source">
+		<ul class="dummy">
+			<li>
+				<a href="index.js.html">index.js</a>,
+				 <a href="index.js.html#sunlight-1-line-96">line 96</a>
+			</li>
+		</ul>
+	</dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>Returns:</h5>
+
+
+<div class="param-desc">
+    <p>This Thumb with this setting applied</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+
+<span class="param-type"><a href="Thumb.html">Thumb</a></span>
+
+
+
+    </dd>
+</dl>
+
+
+
+
+
+</dd>
+
+
+
+<hr>
+<dt>
+    <h4 class="name" id="crop"><span class="type-signature"></span>crop(crop)</h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        <p>Crops the thumb if the resized result doesn't match current ratio,<br>avoiding deformation</p>
+    </div>
+
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+
+        <th>Name</th>
+
+
+        <th>Type</th>
+
+
+
+
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+
+
+        <tr>
+
+                <td class="name"><code>crop</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">boolean</span>
+
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last"><p>true if the Thumb should be cropped, false otherwise</p></td>
+        </tr>
+
+
+    </tbody>
+</table>
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
+	<dd class="tag-source">
+		<ul class="dummy">
+			<li>
+				<a href="index.js.html">index.js</a>,
+				 <a href="index.js.html#sunlight-1-line-112">line 112</a>
+			</li>
+		</ul>
+	</dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>Returns:</h5>
+
+
+<div class="param-desc">
+    <p>This Thumb with this setting applied</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+
+<span class="param-type"><a href="Thumb.html">Thumb</a></span>
+
+
+
+    </dd>
+</dl>
+
+
+
+
+
+</dd>
+
+
+
 <hr>
 <dt>
     <h4 class="name" id="hasWatermark"><span class="type-signature"></span>hasWatermark()</h4>
@@ -298,7 +622,7 @@ <h4 class="name" id="hasWatermark"><span class="type-signature"></span>hasWaterm
 		<ul class="dummy">
 			<li>
 				<a href="index.js.html">index.js</a>,
-				 <a href="index.js.html#sunlight-1-line-124">line 124</a>
+				 <a href="index.js.html#sunlight-1-line-138">line 138</a>
 			</li>
 		</ul>
 	</dd>
@@ -489,7 +813,7 @@ <h5>Returns:</h5>
 
 
 <div class="param-desc">
-    <p>This Thumb with this level of quality</p>
+    <p>This Thumb with this level of quality applied</p>
 </div>
 
 
@@ -837,7 +1161,7 @@ <h5>Returns:</h5>
 
 
 <div class="param-desc">
-    <p>This Thumb rotated the specified angle</p>
+    <p>This Thumb rotated the specified angle applied</p>
 </div>
 
 
@@ -964,7 +1288,7 @@ <h5>Parameters:</h5>
 		<ul class="dummy">
 			<li>
 				<a href="index.js.html">index.js</a>,
-				 <a href="index.js.html#sunlight-1-line-135">line 135</a>
+				 <a href="index.js.html#sunlight-1-line-149">line 149</a>
 			</li>
 		</ul>
 	</dd>
@@ -1105,7 +1429,7 @@ <h5>Parameters:</h5>
 		<ul class="dummy">
 			<li>
 				<a href="index.js.html">index.js</a>,
-				 <a href="index.js.html#sunlight-1-line-114">line 114</a>
+				 <a href="index.js.html#sunlight-1-line-128">line 128</a>
 			</li>
 		</ul>
 	</dd>