jenkins-bot has submitted this change and it was merged.
Change subject: mediawiki.htmlform: Add jsduck docs
......................................................................
mediawiki.htmlform: Add jsduck docs
Change-Id: Ic82e8d2e0309c7c05017d89bf8b03f2498adc1ab
---
M maintenance/jsduck/config.json
M resources/mediawiki/mediawiki.htmlform.js
2 files changed, 13 insertions(+), 4 deletions(-)
Approvals:
Krinkle: Looks good to me, approved
jenkins-bot: Verified
diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index d0e2628..4907cb7 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 7315677..0284e68 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 ) );
--
To view, visit https://gerrit.wikimedia.org/r/111627
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic82e8d2e0309c7c05017d89bf8b03f2498adc1ab
Gerrit-PatchSet: 4
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: MarkTraceur <[email protected]>
Gerrit-Reviewer: Aaron Schulz <[email protected]>
Gerrit-Reviewer: Jack Phoenix <[email protected]>
Gerrit-Reviewer: Krinkle <[email protected]>
Gerrit-Reviewer: Parent5446 <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
