aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/develop
diff options
context:
space:
mode:
authorNathaniel Guse <nathaniel.guse@gmail.com>2013-07-02 12:59:23 -0500
committerNathaniel Guse <nathaniel.guse@gmail.com>2013-07-02 12:59:23 -0500
commit2507c648fe92de5363bd443839d1bb52f55795b4 (patch)
tree60076fe4fefcc6d0411ef97716799f2f8e41896f /phpBB/develop
parent6bbe92a8d020f1fcfa8de0da50714acf88837295 (diff)
downloadforums-2507c648fe92de5363bd443839d1bb52f55795b4.tar
forums-2507c648fe92de5363bd443839d1bb52f55795b4.tar.gz
forums-2507c648fe92de5363bd443839d1bb52f55795b4.tar.bz2
forums-2507c648fe92de536[ticket/10271] Improved the comments on return_handler.
PHPBB3-10271
Diffstat (limited to 'phpBB')
-rw-r--r--Diffstat (limited to 'phpBB/develop')
0 files changed, 0 insertions, 0 deletions
br/>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)
{