r111435 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r111434‎ | r111435 | r111436 >
Date:23:32, 13 February 2012
Author:werdna
Status:ok (Comments)
Tags:acw-deploy 
Comment:
Doc for r111434
Modified paths:
  • /trunk/extensions/ClickTracking/modules/jquery.clickTracking.js (modified) (history)

Diff [purge]

Index: trunk/extensions/ClickTracking/modules/jquery.clickTracking.js
@@ -23,6 +23,7 @@
2424 * Performs click tracking API call
2525 *
2626 * @param {string} id event identifier
 27+ * @return jqXHR object (see <http://api.jquery.com/jQuery.get/#jqxhr-object>)
2728 */
2829 $.trackAction = function( id ) {
2930 return $.trackActionWithOptions( { 'id' : id });
@@ -32,6 +33,7 @@
3334 *
3435 * @param {string} id event identifier
3536 * @param {string} info additional information to be stored with the click
 37+ * @return jqXHR object (see <http://api.jquery.com/jQuery.get/#jqxhr-object>)
3638 */
3739 $.trackActionWithInfo = function( id, info ) {
3840 return $.trackActionWithOptions( { 'id' : id, 'info' : info });
@@ -41,6 +43,7 @@
4244 * Performs click tracking API call
4345 *
4446 * @param {map} options Data to submit. Valid keys: id, namespace, info, token
 47+ * @return jqXHR object (see <http://api.jquery.com/jQuery.get/#jqxhr-object>)
4548 */
4649 $.trackActionWithOptions = function( options ) {
4750 options = $.extend( {

Past revisions this follows-up on

RevisionCommit summaryAuthorDate
r111434Return jqXHR objectswerdna23:31, 13 February 2012

Comments

#Comment by Johnduhart (talk | contribs)   01:23, 14 February 2012

It's actually @returns, but I'm not sure how closely we're following the standard, since we don't generate any JavaScript docs.

Status & tagging log