From b68602d4e2f42d7e971355466ff74f51b278c35d Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Sun, 27 Apr 2014 16:28:04 +0200 Subject: [PATCH] jquery.checkboxShiftClick: Add jsduck documentation Change-Id: Ifb0ad7bface406e6e322186f92083b2b8877a8af --- maintenance/jsduck/config.json | 1 + .../src/jquery/jquery.checkboxShiftClick.js | 22 +++++++++++++------ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json index 6f91cadd52..019701274c 100644 --- a/maintenance/jsduck/config.json +++ b/maintenance/jsduck/config.json @@ -21,6 +21,7 @@ "../../resources/src/jquery/jquery.badge.js", "../../resources/src/jquery/jquery.byteLength.js", "../../resources/src/jquery/jquery.byteLimit.js", + "../../resources/src/jquery/jquery.checkboxShiftClick.js", "../../resources/src/jquery/jquery.client.js", "../../resources/src/jquery/jquery.colorUtil.js", "../../resources/src/jquery/jquery.getAttrs.js", diff --git a/resources/src/jquery/jquery.checkboxShiftClick.js b/resources/src/jquery/jquery.checkboxShiftClick.js index b206566541..d99e9f0a8b 100644 --- a/resources/src/jquery/jquery.checkboxShiftClick.js +++ b/resources/src/jquery/jquery.checkboxShiftClick.js @@ -1,13 +1,15 @@ /** - * jQuery checkboxShiftClick - * - * This will enable checkboxes to be checked or unchecked in a row by clicking one, - * holding shift and clicking another one. - * - * @author Timo Tijhof, 2011 - 2012 - * @license GPL v2 + * @class jQuery.plugin.checkboxShiftClick */ ( function ( $ ) { + + /** + * Enable checkboxes to be checked or unchecked in a row by clicking one, + * holding shift and clicking another one. + * + * @return {jQuery} + * @chainable + */ $.fn.checkboxShiftClick = function () { var prevCheckbox = null, $box = this; @@ -32,4 +34,10 @@ } ); return $box; }; + + /** + * @class jQuery + * @mixins jQuery.plugin.checkboxShiftClick + */ + }( jQuery ) ); -- 2.20.1