Permalink
Browse files

updated documentation to include sort support

  • Loading branch information...
zanchin committed Aug 5, 2012
1 parent b9dbd55 commit 07f12a253b94cf3454ede8a1d5c95cba521b7ce4
View
@@ -167,7 +167,7 @@ <h1 class="classTitle">List of Files</h1>
</div>
<footer>
<h1>Copyright &copy;2012 CloudMine, LLC. All Rights Reserved.</h1>
- <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon Jul 02 2012 22:03:47 GMT-0700 (PDT)</div>
+ <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sun Aug 05 2012 11:52:26 GMT-0400 (EDT)</div>
</footer>
</body>
</html>
View
@@ -178,7 +178,7 @@ <h1 class="classTitle">List of JavaScript Classes</h1>
</div>
<footer>
<h1>Copyright &copy;2012 CloudMine, LLC. All Rights Reserved.</h1>
- <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon Jul 02 2012 22:03:47 GMT-0700 (PDT)</div>
+ <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sun Aug 05 2012 11:52:26 GMT-0400 (EDT)</div>
</footer>
</body>
</html>
View
@@ -220,6 +220,16 @@ <h1>
</td>
</tr>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/APICall.html#getHeader">getHeader</a></b>(key)
+ </div>
+ <div class="description">Get a response header using case insensitive searching
+Note: It is faster to use the exact casing as no searching is necessary when matching.</div>
+ </td>
+ </tr>
+
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
@@ -416,6 +426,50 @@ <h1>
+ <hr />
+
+ <a name="getHeader"> </a>
+ <div class="fixedFont">
+
+ <span class="light">{string|null}</span>
+ <b>getHeader</b>(key)
+
+ </div>
+ <div class="description">
+ Get a response header using case insensitive searching
+Note: It is faster to use the exact casing as no searching is necessary when matching.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{string}</span> <b>key</b>
+
+ </dt>
+ <dd>The header to retrieve, case insensitive.</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="light fixedFont">{string|null}</span> The value of the header, or null</dd>
+
+ </dl>
+
+
+
+
<hr />
<a name="off"> </a>
@@ -715,7 +769,7 @@ <h1>
</div>
<footer>
<h1>Copyright &copy;2012 CloudMine, LLC. All Rights Reserved.</h1>
- <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon Jul 02 2012 22:03:46 GMT-0700 (PDT)</div>
+ <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sun Aug 05 2012 11:52:26 GMT-0400 (EDT)</div>
</footer>
</body>
</html>
@@ -436,7 +436,7 @@ <h1>
</div>
<footer>
<h1>Copyright &copy;2012 CloudMine, LLC. All Rights Reserved.</h1>
- <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon Jul 02 2012 22:03:46 GMT-0700 (PDT)</div>
+ <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sun Aug 05 2012 11:52:26 GMT-0400 (EDT)</div>
</footer>
</body>
</html>
@@ -561,6 +561,12 @@ <h1>
</dt>
<dd>Set the default result limit for requests</dd>
+ <dt>
+ <span class="light fixedFont">{string}</span> <b>Default.sort</b>
+ <i>Optional</i>
+ </dt>
+ <dd>Set the field on which to sort results</dd>
+
<dt>
<span class="light fixedFont">{integer}</span> <b>Default.skip</b>
<i>Optional</i>
@@ -1999,7 +2005,7 @@ <h1>
</div>
<footer>
<h1>Copyright &copy;2012 CloudMine, LLC. All Rights Reserved.</h1>
- <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon Jul 02 2012 22:03:46 GMT-0700 (PDT)</div>
+ <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sun Aug 05 2012 11:52:26 GMT-0400 (EDT)</div>
</footer>
</body>
</html>
@@ -176,7 +176,7 @@ <h2 id='secondary-nav'>
</div>
<footer>
<h1>Copyright &copy;2012 CloudMine, LLC. All Rights Reserved.</h1>
- <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Mon Jul 02 2012 22:03:46 GMT-0700 (PDT)</div>
+ <div>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sun Aug 05 2012 11:52:25 GMT-0400 (EDT)</div>
</footer>
</body>
</html>
Oops, something went wrong.

0 comments on commit 07f12a2

Please sign in to comment.