jenkins-bot has submitted this change and it was merged.
Change subject: jquery.spinner: Improve documentation formatting
......................................................................
jquery.spinner: Improve documentation formatting
Follow-up to I1dc2cdc2. I just learned this is possible, which is awesome.
Change-Id: Ib06344c19bb0637c885441aec5e5296efe7d019f
---
M resources/jquery/jquery.spinner.js
1 file changed, 7 insertions(+), 10 deletions(-)
Approvals:
Nikerabbit: Looks good to me, approved
jenkins-bot: Verified
diff --git a/resources/jquery/jquery.spinner.js
b/resources/jquery/jquery.spinner.js
index 1cd6ff0..71246e4 100644
--- a/resources/jquery/jquery.spinner.js
+++ b/resources/jquery/jquery.spinner.js
@@ -49,16 +49,13 @@
*
* @static
* @inheritable
- * @param {Object|string} [opts] Options. An object with the
following keys:
- *
- * - id: If given, spinner will be given an id of
"mw-spinner-{id}"
- * - size: 'small' (default) or 'large' for a 20-pixel or
32-pixel spinner
- * - type: 'inline' (default) or 'block'. Inline creates an
inline-block with width and
- * height equal to spinner size. Block is a block-level
element with width 100%, height
- * equal to spinner size.
- *
- * If a string is given, it will be treated as the value of the
'id' option.
- *
+ * @param {Object|string} [opts] Options. If a string is given,
it will be treated as the value
+ * of the `id` option. If an object is given, the possible
option keys are:
+ * @param {string} [opts.id] If given, spinner will be given an
id of "mw-spinner-{id}".
+ * @param {string} [opts.size='small'] 'small' or 'large' for a
20-pixel or 32-pixel spinner.
+ * @param {string} [opts.type='inline'] 'inline' or 'block'.
Inline creates an inline-block with
+ * width and height equal to spinner size. Block is a
block-level element with width 100%,
+ * height equal to spinner size.
* @return {jQuery}
*/
createSpinner: function ( opts ) {
--
To view, visit https://gerrit.wikimedia.org/r/98378
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ib06344c19bb0637c885441aec5e5296efe7d019f
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Bartosz Dziewoński <matma....@gmail.com>
Gerrit-Reviewer: Jack Phoenix <j...@countervandalism.net>
Gerrit-Reviewer: Krinkle <krinklem...@gmail.com>
Gerrit-Reviewer: Nikerabbit <niklas.laxst...@gmail.com>
Gerrit-Reviewer: Siebrand <siebr...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
