X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=resources%2Fmediawiki%2Fmediawiki.htmlform.js;h=0284e68a6ce23b7c109179b12865c712cb2f94a2;hb=88c1d93cb07670b971e16a6923e5c86144151fad;hp=7315677233b839fc67f5846704778ba6a598a12f;hpb=60f114d8f5955d172680784935791e0254251c97;p=lhc%2Fweb%2Fwiklou.git

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