aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/assets
diff options
context:
space:
mode:
authorCallum Macrae <callum@lynxphp.com>2011-10-22 16:40:37 +0100
committerIgor Wiedler <igor@wiedler.ch>2012-03-31 02:09:20 +0200
commit8a2f5f326930469ff85ea7d8ef3458fe4b6def48 (patch)
treed7b719a9fc8b3482c20a2973859302d2149bd2c6 /phpBB/assets
parent81200236052333f88bbf6ecf0c2198080481c07a (diff)
downloadforums-8a2f5f326930469ff85ea7d8ef3458fe4b6def48.tar
forums-8a2f5f326930469ff85ea7d8ef3458fe4b6def48.tar.gz
forums-8a2f5f326930469ff85ea7d8ef3458fe4b6def48.tar.bz2
forums-8a2f5f326930469ff85ea7d8ef3458fe4b6def48.tar.xz
forums-8a2f5f326930469ff85ea7d8ef3458fe4b6def48.zip
[ticket/10271] Improved the comments on return_handler.
PHPBB3-10271
Diffstat (limited to 'phpBB/assets')
-rw-r--r--phpBB/assets/javascript/core.js9
1 files changed, 7 insertions, 2 deletions
diff --git a/phpBB/assets/javascript/core.js b/phpBB/assets/javascript/core.js
index 3d75cd291f..fe85bd9780 100644
--- a/phpBB/assets/javascript/core.js
+++ b/phpBB/assets/javascript/core.js
@@ -235,8 +235,13 @@ phpbb.ajaxify = function(options, refresh, callback) {
/**
* This is a private function used to handle the callbacks, refreshes
- * and alert. It cannot be called from outside this function, and is purely
- * here to avoid repetition of code.
+ * and alert. It calls the callback, refreshes the page if necessary, and
+ * displays an alert to the user and removes it after an amount of time.
+ *
+ * It cannot be called from outside this function, and is purely here to
+ * avoid repetition of code.
+ *
+ * @param object res The object sent back by the server.
*/
function return_handler(res)
{