r102730 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r102729‎ | r102730 | r102731 >
Date:01:27, 11 November 2011
Author:neilk
Status:ok
Tags:
Comment:
add documentation to api methods
Modified paths:
  • /trunk/extensions/UploadWizard/resources/mw.Api.category.js (modified) (history)

Diff [purge]

Index: trunk/extensions/UploadWizard/resources/mw.Api.category.js
@@ -4,6 +4,7 @@
55
66 $.extend( mw.Api.prototype, {
77 /**
 8+ * Determine if a category exists
89 * @param {mw.Title}
910 * @param {Function} callback to pass boolean of category's existence
1011 * @param {Function} optional callback to run if api error
@@ -32,6 +33,8 @@
3334 },
3435
3536 /**
 37+ * Get a list of categories that match a certain prefix.
 38+ * e.g. given "Foo", return "Food", "Foolish people", "Foosball tables" ...
3639 * @param {String} prefix to match
3740 * @param {Function} callback to pass matched categories to
3841 * @param {Function} optional callback to run if api error
@@ -62,6 +65,7 @@
6366
6467
6568 /**
 69+ * Get the categories that a particular page on the wiki belongs to
6670 * @param {mw.Title}
6771 * @param {Function} callback to pass categories to (or false, if title not found)
6872 * @param {Function} optional callback to run if api error

Status & tagging log