jquery.spinner: Improve documentation formatting
authorBartosz Dziewoński <matma.rex@gmail.com>
Sun, 1 Dec 2013 15:21:14 +0000 (16:21 +0100)
committerBartosz Dziewoński <matma.rex@gmail.com>
Sun, 1 Dec 2013 15:21:14 +0000 (16:21 +0100)
Follow-up to I1dc2cdc2. I just learned this is possible, which is awesome.

Change-Id: Ib06344c19bb0637c885441aec5e5296efe7d019f

resources/jquery/jquery.spinner.js

index 1cd6ff0..71246e4 100644 (file)
                 *
                 * @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 ) {