From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Fri, 14 Mar 2014 17:59:55 +0000 (+0100)
Subject: mediawiki.api: Documentation and typo cleanup
X-Git-Tag: 1.31.0-rc.0~16443
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/exercices/bilan.php?a=commitdiff_plain;h=46931e413bd3b9975e70d14050d104088a3b5ffa;p=lhc%2Fweb%2Fwiklou.git

mediawiki.api: Documentation and typo cleanup

Also changed some whitespace.

Change-Id: I307c516f41258c06c0bff4ddb8dc9c1aaca44462
---

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 } );
 		}
-
 	} );
 
 	/**