From 91659352c36d055c78eb27f7752c27933425c34b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Sun, 1 Dec 2013 16:21:14 +0100 Subject: [PATCH] jquery.spinner: Improve documentation formatting Follow-up to I1dc2cdc2. I just learned this is possible, which is awesome. Change-Id: Ib06344c19bb0637c885441aec5e5296efe7d019f --- resources/jquery/jquery.spinner.js | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/resources/jquery/jquery.spinner.js b/resources/jquery/jquery.spinner.js index 1cd6ff0576..71246e4489 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 ) { -- 2.20.1