From: Timo Tijhof <krinklemail@gmail.com>
Date: Sun, 27 Apr 2014 14:28:04 +0000 (+0200)
Subject: jquery.checkboxShiftClick: Add jsduck documentation
X-Git-Tag: 1.31.0-rc.0~15976^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/membres/message.php?a=commitdiff_plain;h=b68602d4e2f42d7e971355466ff74f51b278c35d;p=lhc%2Fweb%2Fwiklou.git

jquery.checkboxShiftClick: Add jsduck documentation

Change-Id: Ifb0ad7bface406e6e322186f92083b2b8877a8af
---

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 ) );