From: Mark Holmquist <mtraceur@member.fsf.org>
Date: Wed, 5 Feb 2014 23:00:58 +0000 (-0800)
Subject: mediawiki.htmlform: Add jsduck docs
X-Git-Tag: 1.31.0-rc.0~17000^2
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/exercices/modifier.php?a=commitdiff_plain;h=1547148d0d9cca01a21a3c1b292000e0dfbf407e;p=lhc%2Fweb%2Fwiklou.git

mediawiki.htmlform: Add jsduck docs

Change-Id: Ic82e8d2e0309c7c05017d89bf8b03f2498adc1ab
---

diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index d0e26284de..4907cb764b 100644
--- a/maintenance/jsduck/config.json
+++ b/maintenance/jsduck/config.json
@@ -10,6 +10,7 @@
 	"--": [
 		"./external.js",
 		"../../resources/mediawiki/mediawiki.js",
+		"../../resources/mediawiki/mediawiki.htmlform.js",
 		"../../resources/mediawiki/mediawiki.log.js",
 		"../../resources/mediawiki/mediawiki.util.js",
 		"../../resources/mediawiki/mediawiki.Title.js",
diff --git a/resources/mediawiki/mediawiki.htmlform.js b/resources/mediawiki/mediawiki.htmlform.js
index 7315677233..0284e68a6c 100644
--- a/resources/mediawiki/mediawiki.htmlform.js
+++ b/resources/mediawiki/mediawiki.htmlform.js
@@ -1,12 +1,14 @@
 /**
  * Utility functions for jazzing up HTMLForm elements.
+ *
+ * @class jQuery.plugin.htmlform
  */
 ( function ( mw, $ ) {
 
 	/**
 	 * jQuery plugin to fade or snap to visible state.
 	 *
-	 * @param {boolean} instantToggle [optional]
+	 * @param {boolean} [instantToggle=false]
 	 * @return {jQuery}
 	 */
 	$.fn.goIn = function ( instantToggle ) {
@@ -19,7 +21,7 @@
 	/**
 	 * jQuery plugin to fade or snap to hiding state.
 	 *
-	 * @param {boolean} instantToggle [optional]
+	 * @param {boolean} [instantToggle=false]
 	 * @return jQuery
 	 */
 	$.fn.goOut = function ( instantToggle ) {
@@ -32,8 +34,9 @@
 	/**
 	 * Bind a function to the jQuery object via live(), and also immediately trigger
 	 * the function on the objects with an 'instant' parameter set to true.
-	 * @param {Function} callback Takes one parameter, which is {true} when the
-	 *  event is called immediately, and {jQuery.Event} when triggered from an event.
+	 * @param {Function} callback
+	 * @param {boolean|jQuery.Event} callback.immediate True when the event is called immediately,
+	 *  an event object when triggered from an event.
 	 */
 	$.fn.liveAndTestAtStart = function ( callback ) {
 		$( this )
@@ -125,4 +128,9 @@
 			} );
 		}
 	} );
+
+	/**
+	 * @class jQuery
+	 * @mixins jQuery.plugin.htmlform
+	 */
 }( mediaWiki, jQuery ) );