Merge pull request #7797 from mrclay/jqXHR

chore(js): more precisely document return type of elgg.ajax functions
Elgg · Jan 20, 2015 · 74a53e7 · 74a53e7
2 parents f5a0a16 + d23223f
commit 74a53e7
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/js/lib/ajax.js b/js/lib/ajax.js
@@ -14,7 +14,7 @@ elgg.provide('elgg.ajax');
  *
  * @param {string} url Optionally specify the url as the first argument
  * @param {Object} options Optional. {@link jQuery#ajax}
- * @return {XmlHttpRequest}
+ * @return {jqXHR}
  */
 elgg.ajax = function(url, options) {
 	options = elgg.ajax.handleOptions(url, options);
@@ -91,7 +91,7 @@ elgg.ajax.handleOptions = function(url, options) {
  *
  * @param {string} url Optionally specify the url as the first argument
  * @param {Object} options {@link jQuery#ajax}
- * @return {XmlHttpRequest}
+ * @return {jqXHR}
  */
 elgg.get = function(url, options) {
 	options = elgg.ajax.handleOptions(url, options);
@@ -105,7 +105,7 @@ elgg.get = function(url, options) {
  *
  * @param {string} url Optionally specify the url as the first argument
  * @param {Object} options {@link jQuery#ajax}
- * @return {XmlHttpRequest}
+ * @return {jqXHR}
  */
 elgg.getJSON = function(url, options) {
 	options = elgg.ajax.handleOptions(url, options);
@@ -119,7 +119,7 @@ elgg.getJSON = function(url, options) {
  *
  * @param {string} url Optionally specify the url as the first argument
  * @param {Object} options {@link jQuery#ajax}
- * @return {XmlHttpRequest}
+ * @return {jqXHR}
  */
 elgg.post = function(url, options) {
 	options = elgg.ajax.handleOptions(url, options);
@@ -173,7 +173,7 @@ elgg.post = function(url, options) {
  *
  * @param {String} action The action to call.
  * @param {Object} options
- * @return {XMLHttpRequest}
+ * @return {jqXHR}
  */
 elgg.action = function(action, options) {
 	elgg.assertTypeOf('string', action);
@@ -222,7 +222,7 @@ elgg.action = function(action, options) {
  *
  * @param {String} method The API method to be called
  * @param {Object} options {@link jQuery#ajax}
- * @return {XmlHttpRequest}
+ * @return {jqXHR}
  */
 elgg.api = function (method, options) {
 	elgg.assertTypeOf('string', method);