From 46931e413bd3b9975e70d14050d104088a3b5ffa Mon Sep 17 00:00:00 2001 From: =?utf8?q?Bartosz=20Dziewo=C5=84ski?= Date: Fri, 14 Mar 2014 18:59:55 +0100 Subject: [PATCH] mediawiki.api: Documentation and typo cleanup Also changed some whitespace. Change-Id: I307c516f41258c06c0bff4ddb8dc9c1aaca44462 --- resources/mediawiki.api/mediawiki.api.category.js | 11 ++++++----- resources/mediawiki.api/mediawiki.api.parse.js | 2 +- resources/mediawiki.api/mediawiki.api.watch.js | 3 +-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/resources/mediawiki.api/mediawiki.api.category.js b/resources/mediawiki.api/mediawiki.api.category.js index 4321b1b478..7435e04439 100644 --- a/resources/mediawiki.api/mediawiki.api.category.js +++ b/resources/mediawiki.api/mediawiki.api.category.js @@ -7,7 +7,8 @@ $.extend( mw.Api.prototype, { /** * Determine if a category exists. - * @param {mw.Title} title + * + * @param {mw.Title|string} title * @param {Function} [ok] Success callback (deprecated) * @param {Function} [err] Error callback (deprecated) * @return {jQuery.Promise} @@ -46,7 +47,7 @@ /** * Get a list of categories that match a certain prefix. * - * E.g. given "Foo", return "Food", "Foolish people", "Foosball tables" ... + * E.g. given "Foo", return "Food", "Foolish people", "Foosball tables"... * * @param {string} prefix Prefix to match. * @param {Function} [ok] Success callback (deprecated) @@ -85,8 +86,9 @@ }, /** - * Get the categories that a particular page on the wiki belongs to - * @param {mw.Title} title + * Get the categories that a particular page on the wiki belongs to. + * + * @param {mw.Title|string} title * @param {Function} [ok] Success callback (deprecated) * @param {Function} [err] Error callback (deprecated) * @param {boolean} [async=true] Asynchronousness @@ -130,7 +132,6 @@ .fail( err ) .promise( { abort: apiPromise.abort } ); } - } ); /** diff --git a/resources/mediawiki.api/mediawiki.api.parse.js b/resources/mediawiki.api/mediawiki.api.parse.js index 952dea4730..b1f1d2b06f 100644 --- a/resources/mediawiki.api/mediawiki.api.parse.js +++ b/resources/mediawiki.api/mediawiki.api.parse.js @@ -5,7 +5,7 @@ $.extend( mw.Api.prototype, { /** - * Convinience method for 'action=parse'. + * Convenience method for 'action=parse'. * * @param {string} wikitext * @param {Function} [ok] Success callback (deprecated) diff --git a/resources/mediawiki.api/mediawiki.api.watch.js b/resources/mediawiki.api/mediawiki.api.watch.js index 9d65e1f3ed..aa33d86528 100644 --- a/resources/mediawiki.api/mediawiki.api.watch.js +++ b/resources/mediawiki.api/mediawiki.api.watch.js @@ -24,7 +24,7 @@ */ function doWatchInternal( pages, ok, err, addParams ) { // XXX: Parameter addParams is undocumented because we inherit this - // documentation in the public method.. + // documentation in the public method... var apiPromise = this.post( $.extend( { @@ -70,7 +70,6 @@ unwatch: function ( pages, ok, err ) { return doWatchInternal.call( this, pages, ok, err, { unwatch: 1 } ); } - } ); /** -- 2.20.1