Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

move comment blocks, add date to changelog, update jshint

  • Loading branch information...
commit b35c957b32287838dc0b2983a0c1702a17d9e9c7 1 parent c8f0198
@wjbryant authored
View
2  CHANGELOG.md
@@ -1,6 +1,6 @@
# Tab Override jQuery Plugin Changelog
-## 4.0.0
+## 4.0.0 (2013-08-27)
* Use `handlers` namespace
* Added hooks for extension system: `setDelegated`, `addDelegatedListeners`, `removeDelegatedListeners`
* Added `utils` namespace with `addDelegatedListeners()` and `removeDelegatedListeners()` methods
View
65 build/jquery.taboverride.js
@@ -39,7 +39,7 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
* Helper function to remove the delegated listeners. This is only used in
* the removeDelegatedListeners and addDelegatedListeners functions.
*
- * @see external:"jQuery.fn".tabOverride.removeDelegatedListeners
+ * @see external:"jQuery.fn".tabOverride.utils.removeDelegatedListeners
* @private
*/
function removeDelegatedListenersHelper( $container, selector ) {
@@ -50,8 +50,16 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
}
/**
- * @see external:"jQuery.fn".tabOverride.removeDelegatedListeners
- * @private
+ * Removes the Tab Override event listeners on the container element
+ * using jQuery delegated events.
+ *
+ * Hooks: removeDelegatedListeners - passed the jQuery object for the
+ * container element(s) and the selector string
+ *
+ * @param {Object} $container the jQuery object for the container element
+ * @param {string} selector the selector string to use for the delegated events
+ *
+ * @method external:"jQuery.fn".tabOverride.utils.removeDelegatedListeners
*/
function removeDelegatedListeners( $container, selector ) {
tabOverride.utils.executeExtensions( "removeDelegatedListeners", [ $container, selector ] );
@@ -59,8 +67,16 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
}
/**
- * @see external:"jQuery.fn".tabOverride.addDelegatedListeners
- * @private
+ * Adds the Tab Override event listeners to the container element using
+ * jQuery delegated events.
+ *
+ * Hooks: addDelegatedListeners - passed the jQuery object for the
+ * container element(s) and the selector string
+ *
+ * @param {Object} $container the jQuery object for the container element
+ * @param {string} selector the selector string to use for the delegated events
+ *
+ * @method external:"jQuery.fn".tabOverride.utils.addDelegatedListeners
*/
function addDelegatedListeners( $container, selector ) {
tabOverride.utils.executeExtensions( "addDelegatedListeners", [ $container, selector ] );
@@ -124,34 +140,7 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
* @namespace external:"jQuery.fn".tabOverride.utils
*/
$fnTabOverride.utils = {
- /**
- * Adds the Tab Override event listeners to the container element using
- * jQuery delegated events.
- *
- * Hooks: addDelegatedListeners - passed the jQuery object for the
- * container element(s) and the selector string
- *
- * @param {Object} $container the jQuery object for the container element
- * @param {string} selector the selector string to use for the delegated events
- *
- * @method
- * @memberOf external:"jQuery.fn".tabOverride.utils
- */
addDelegatedListeners: addDelegatedListeners,
-
- /**
- * Removes the Tab Override event listeners on the container element
- * using jQuery delegated events.
- *
- * Hooks: removeDelegatedListeners - passed the jQuery object for the
- * container element(s) and the selector string
- *
- * @param {Object} $container the jQuery object for the container element
- * @param {string} selector the selector string to use for the delegated events
- *
- * @method
- * @memberOf external:"jQuery.fn".tabOverride.utils
- */
removeDelegatedListeners: removeDelegatedListeners
};
@@ -162,8 +151,7 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
* @param {number} [size] the tab size
* @return {number|Function} the tab size or the tabOverride function
*
- * @method tabSize
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.tabSize
*/
$fnTabOverride.tabSize = tabOverride.tabSize;
@@ -175,8 +163,7 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
* @return {boolean|Function} whether auto indent is enabled or the
* tabOverride function
*
- * @method autoIndent
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.autoIndent
*/
$fnTabOverride.autoIndent = tabOverride.autoIndent;
@@ -189,8 +176,7 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
* @return {string|Function} the current tab key combination or the
* tabOverride function
*
- * @method tabKey
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.tabKey
*/
$fnTabOverride.tabKey = tabOverride.tabKey;
@@ -203,8 +189,7 @@ Copyright (c) 2013 Bill Bryant | http://opensource.org/licenses/mit */
* @return {string|Function} the current untab key combination or the
* tabOverride function
*
- * @method untabKey
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.untabKey
*/
$fnTabOverride.untabKey = tabOverride.untabKey;
}));
View
4 docs/_.html
@@ -251,7 +251,7 @@ <h4 class="name" id="tabOverride"><span class="type-signature">&lt;static> </spa
-
+
@@ -320,7 +320,7 @@ <h4 class="name" id="tabOverride"><span class="type-signature">&lt;static> </spa
</div>
<nav>
- <h2><a href="index.html">Index</a></h2><h3>Externals</h3><ul><li><a href="_.html">jQuery.fn</a></li></ul><h3>Namespaces</h3><ul><li><a href="tabOverride.html">tabOverride</a></li><li><a href="tabOverride.utils.html">utils</a></li></ul>
+ <h2><a href="index.html">Index</a></h2><h3>Externals</h3><ul><li><a href="_.html">jQuery.fn</a></li></ul><h3>Namespaces</h3><ul><li><a href="tabOverride.html">tabOverride</a></li><li><a href="tabOverride.utils.html">utils</a></li></ul>
</nav>
<br clear="both">
View
2  docs/index.html
@@ -147,7 +147,7 @@ <h1 class="page-title">Index</h1>
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Wed Aug 21 2013 13:48:46 GMT-0400 (EDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Tue Aug 27 2013 13:47:55 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
View
67 docs/jquery.taboverride.js.html
@@ -66,7 +66,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
* Helper function to remove the delegated listeners. This is only used in
* the removeDelegatedListeners and addDelegatedListeners functions.
*
- * @see external:"jQuery.fn".tabOverride.removeDelegatedListeners
+ * @see external:"jQuery.fn".tabOverride.utils.removeDelegatedListeners
* @private
*/
function removeDelegatedListenersHelper( $container, selector ) {
@@ -77,8 +77,16 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
}
/**
- * @see external:"jQuery.fn".tabOverride.removeDelegatedListeners
- * @private
+ * Removes the Tab Override event listeners on the container element
+ * using jQuery delegated events.
+ *
+ * Hooks: removeDelegatedListeners - passed the jQuery object for the
+ * container element(s) and the selector string
+ *
+ * @param {Object} $container the jQuery object for the container element
+ * @param {string} selector the selector string to use for the delegated events
+ *
+ * @method external:"jQuery.fn".tabOverride.utils.removeDelegatedListeners
*/
function removeDelegatedListeners( $container, selector ) {
tabOverride.utils.executeExtensions( "removeDelegatedListeners", [ $container, selector ] );
@@ -86,8 +94,16 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
}
/**
- * @see external:"jQuery.fn".tabOverride.addDelegatedListeners
- * @private
+ * Adds the Tab Override event listeners to the container element using
+ * jQuery delegated events.
+ *
+ * Hooks: addDelegatedListeners - passed the jQuery object for the
+ * container element(s) and the selector string
+ *
+ * @param {Object} $container the jQuery object for the container element
+ * @param {string} selector the selector string to use for the delegated events
+ *
+ * @method external:"jQuery.fn".tabOverride.utils.addDelegatedListeners
*/
function addDelegatedListeners( $container, selector ) {
tabOverride.utils.executeExtensions( "addDelegatedListeners", [ $container, selector ] );
@@ -151,34 +167,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
* @namespace external:"jQuery.fn".tabOverride.utils
*/
$fnTabOverride.utils = {
- /**
- * Adds the Tab Override event listeners to the container element using
- * jQuery delegated events.
- *
- * Hooks: addDelegatedListeners - passed the jQuery object for the
- * container element(s) and the selector string
- *
- * @param {Object} $container the jQuery object for the container element
- * @param {string} selector the selector string to use for the delegated events
- *
- * @method
- * @memberOf external:"jQuery.fn".tabOverride.utils
- */
addDelegatedListeners: addDelegatedListeners,
-
- /**
- * Removes the Tab Override event listeners on the container element
- * using jQuery delegated events.
- *
- * Hooks: removeDelegatedListeners - passed the jQuery object for the
- * container element(s) and the selector string
- *
- * @param {Object} $container the jQuery object for the container element
- * @param {string} selector the selector string to use for the delegated events
- *
- * @method
- * @memberOf external:"jQuery.fn".tabOverride.utils
- */
removeDelegatedListeners: removeDelegatedListeners
};
@@ -189,8 +178,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
* @param {number} [size] the tab size
* @return {number|Function} the tab size or the tabOverride function
*
- * @method tabSize
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.tabSize
*/
$fnTabOverride.tabSize = tabOverride.tabSize;
@@ -202,8 +190,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
* @return {boolean|Function} whether auto indent is enabled or the
* tabOverride function
*
- * @method autoIndent
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.autoIndent
*/
$fnTabOverride.autoIndent = tabOverride.autoIndent;
@@ -216,8 +203,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
* @return {string|Function} the current tab key combination or the
* tabOverride function
*
- * @method tabKey
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.tabKey
*/
$fnTabOverride.tabKey = tabOverride.tabKey;
@@ -230,8 +216,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
* @return {string|Function} the current untab key combination or the
* tabOverride function
*
- * @method untabKey
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.untabKey
*/
$fnTabOverride.untabKey = tabOverride.untabKey;
}));
@@ -251,7 +236,7 @@ <h1 class="page-title">Source: jquery.taboverride.js</h1>
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Wed Aug 21 2013 13:48:46 GMT-0400 (EDT)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Tue Aug 27 2013 13:47:55 GMT-0400 (EDT)
</footer>
<script> prettyPrint(); </script>
View
12 docs/tabOverride.html
@@ -66,7 +66,7 @@ <h1 class="page-title">Namespace: tabOverride</h1>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.taboverride.js.html">jquery.taboverride.js</a>, <a href="jquery.taboverride.js.html#line74">line 74</a>
+ <a href="jquery.taboverride.js.html">jquery.taboverride.js</a>, <a href="jquery.taboverride.js.html#line90">line 90</a>
</li></ul></dd>
@@ -208,7 +208,7 @@ <h4 class="name" id="autoIndent"><span class="type-signature">&lt;static> </span
<dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
+ <dd class="tag-source"><ul class="dummy"><li>
<a href="jquery.taboverride.js.html">jquery.taboverride.js</a>, <a href="jquery.taboverride.js.html#line158">line 158</a>
</li></ul></dd>
@@ -393,7 +393,7 @@ <h4 class="name" id="tabKey"><span class="type-signature">&lt;static> </span>tab
-
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jquery.taboverride.js.html">jquery.taboverride.js</a>, <a href="jquery.taboverride.js.html#line170">line 170</a>
@@ -547,7 +547,7 @@ <h4 class="name" id="tabSize"><span class="type-signature">&lt;static> </span>ta
-
+
<dt class="tag-source">Source:</dt>
@@ -732,7 +732,7 @@ <h4 class="name" id="untabKey"><span class="type-signature">&lt;static> </span>u
-
+
@@ -804,7 +804,7 @@ <h4 class="name" id="untabKey"><span class="type-signature">&lt;static> </span>u
</div>
-<nav>
+<nav>
<h2><a href="index.html">Index</a></h2><h3>Externals</h3><ul><li><a href="_.html">jQuery.fn</a></li></ul><h3>Namespaces</h3><ul><li><a href="tabOverride.html">tabOverride</a></li><li><a href="tabOverride.utils.html">utils</a></li></ul>
</nav>
View
8 docs/tabOverride.utils.html
@@ -66,7 +66,7 @@ <h1 class="page-title">Namespace: utils</h1>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.taboverride.js.html">jquery.taboverride.js</a>, <a href="jquery.taboverride.js.html#line121">line 121</a>
+ <a href="jquery.taboverride.js.html">jquery.taboverride.js</a>, <a href="jquery.taboverride.js.html#line137">line 137</a>
</li></ul></dd>
@@ -212,7 +212,7 @@ <h4 class="name" id="addDelegatedListeners"><span class="type-signature">&lt;sta
-
+
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
@@ -352,7 +352,7 @@ <h4 class="name" id="removeDelegatedListeners"><span class="type-signature">&lt;
-
+
@@ -399,7 +399,7 @@ <h4 class="name" id="removeDelegatedListeners"><span class="type-signature">&lt;
</div>
-
+
<nav>
<h2><a href="index.html">Index</a></h2><h3>Externals</h3><ul><li><a href="_.html">jQuery.fn</a></li></ul><h3>Namespaces</h3><ul><li><a href="tabOverride.html">tabOverride</a></li><li><a href="tabOverride.utils.html">utils</a></li></ul>
</nav>
View
2  package.json
@@ -29,7 +29,7 @@
"bugs": "https://github.com/wjbryant/jquery.taboverride/issues",
"devDependencies": {
"grunt": "~0.4.1",
- "grunt-contrib-jshint": "~0.6.2",
+ "grunt-contrib-jshint": "~0.6.3",
"grunt-contrib-clean": "~0.5.0",
"grunt-contrib-concat": "~0.3.0",
"grunt-contrib-uglify": "~0.2.2",
View
65 src/jquery.taboverride.js
@@ -30,7 +30,7 @@
* Helper function to remove the delegated listeners. This is only used in
* the removeDelegatedListeners and addDelegatedListeners functions.
*
- * @see external:"jQuery.fn".tabOverride.removeDelegatedListeners
+ * @see external:"jQuery.fn".tabOverride.utils.removeDelegatedListeners
* @private
*/
function removeDelegatedListenersHelper( $container, selector ) {
@@ -41,8 +41,16 @@
}
/**
- * @see external:"jQuery.fn".tabOverride.removeDelegatedListeners
- * @private
+ * Removes the Tab Override event listeners on the container element
+ * using jQuery delegated events.
+ *
+ * Hooks: removeDelegatedListeners - passed the jQuery object for the
+ * container element(s) and the selector string
+ *
+ * @param {Object} $container the jQuery object for the container element
+ * @param {string} selector the selector string to use for the delegated events
+ *
+ * @method external:"jQuery.fn".tabOverride.utils.removeDelegatedListeners
*/
function removeDelegatedListeners( $container, selector ) {
tabOverride.utils.executeExtensions( "removeDelegatedListeners", [ $container, selector ] );
@@ -50,8 +58,16 @@
}
/**
- * @see external:"jQuery.fn".tabOverride.addDelegatedListeners
- * @private
+ * Adds the Tab Override event listeners to the container element using
+ * jQuery delegated events.
+ *
+ * Hooks: addDelegatedListeners - passed the jQuery object for the
+ * container element(s) and the selector string
+ *
+ * @param {Object} $container the jQuery object for the container element
+ * @param {string} selector the selector string to use for the delegated events
+ *
+ * @method external:"jQuery.fn".tabOverride.utils.addDelegatedListeners
*/
function addDelegatedListeners( $container, selector ) {
tabOverride.utils.executeExtensions( "addDelegatedListeners", [ $container, selector ] );
@@ -115,34 +131,7 @@
* @namespace external:"jQuery.fn".tabOverride.utils
*/
$fnTabOverride.utils = {
- /**
- * Adds the Tab Override event listeners to the container element using
- * jQuery delegated events.
- *
- * Hooks: addDelegatedListeners - passed the jQuery object for the
- * container element(s) and the selector string
- *
- * @param {Object} $container the jQuery object for the container element
- * @param {string} selector the selector string to use for the delegated events
- *
- * @method
- * @memberOf external:"jQuery.fn".tabOverride.utils
- */
addDelegatedListeners: addDelegatedListeners,
-
- /**
- * Removes the Tab Override event listeners on the container element
- * using jQuery delegated events.
- *
- * Hooks: removeDelegatedListeners - passed the jQuery object for the
- * container element(s) and the selector string
- *
- * @param {Object} $container the jQuery object for the container element
- * @param {string} selector the selector string to use for the delegated events
- *
- * @method
- * @memberOf external:"jQuery.fn".tabOverride.utils
- */
removeDelegatedListeners: removeDelegatedListeners
};
@@ -153,8 +142,7 @@
* @param {number} [size] the tab size
* @return {number|Function} the tab size or the tabOverride function
*
- * @method tabSize
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.tabSize
*/
$fnTabOverride.tabSize = tabOverride.tabSize;
@@ -166,8 +154,7 @@
* @return {boolean|Function} whether auto indent is enabled or the
* tabOverride function
*
- * @method autoIndent
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.autoIndent
*/
$fnTabOverride.autoIndent = tabOverride.autoIndent;
@@ -180,8 +167,7 @@
* @return {string|Function} the current tab key combination or the
* tabOverride function
*
- * @method tabKey
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.tabKey
*/
$fnTabOverride.tabKey = tabOverride.tabKey;
@@ -194,8 +180,7 @@
* @return {string|Function} the current untab key combination or the
* tabOverride function
*
- * @method untabKey
- * @memberOf external:"jQuery.fn".tabOverride
+ * @method external:"jQuery.fn".tabOverride.untabKey
*/
$fnTabOverride.untabKey = tabOverride.untabKey;
}));
Please sign in to comment.
Something went wrong with that request. Please try again.