From 8a2f5f326930469ff85ea7d8ef3458fe4b6def48 Mon Sep 17 00:00:00 2001 From: Callum Macrae Date: Sat, 22 Oct 2011 16:40:37 +0100 Subject: [PATCH] [ticket/10271] Improved the comments on return_handler. PHPBB3-10271 --- phpBB/assets/javascript/core.js | 9 +++++++-- 1 file 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) {