diff options
| author | Callum Macrae <callum@lynxphp.com> | 2011-08-24 11:44:28 +0100 |
|---|---|---|
| committer | Igor Wiedler <igor@wiedler.ch> | 2012-03-31 02:09:14 +0200 |
| commit | c92b30d66cbb2839369c04172eb5ae9bacd27a16 (patch) | |
| tree | f057ab790fd659ceb23ede25bf0b8788af3e2537 | |
| parent | 420de9c9a0a638135da147a498436dbe7abfd4bd (diff) | |
| download | forums-c92b30d66cbb2839369c04172eb5ae9bacd27a16.tar forums-c92b30d66cbb2839369c04172eb5ae9bacd27a16.tar.gz forums-c92b30d66cbb2839369c04172eb5ae9bacd27a16.tar.bz2 forums-c92b30d66cbb2839369c04172eb5ae9bacd27a16.tar.xz forums-c92b30d66cbb2839369c04172eb5ae9bacd27a16.zip | |
[feature/ajax] Changed JavaScript comments to follow coding guidelines.
Also replaced a couple instances of "@return" with "@returns".
PHPBB3-10270
| -rw-r--r-- | phpBB/styles/script.js | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/phpBB/styles/script.js b/phpBB/styles/script.js index bf8c548df0..1b9262f585 100644 --- a/phpBB/styles/script.js +++ b/phpBB/styles/script.js @@ -1,6 +1,6 @@ var phpbb = {}; -(function($) { //avoid conflicts with other libraries +(function($) { // Avoid conflicts with other libraries var dark = $('#darkenwrapper'), @@ -9,6 +9,8 @@ var dark = $('#darkenwrapper'), /** * Display a loading screen. + * + * @returns object Returns loading_alert. */ phpbb.loading_alert = function() { if (dark.is(':visible')) @@ -39,7 +41,7 @@ phpbb.loading_alert = function() { * @param bool fadedark Remove the dark background when done? Defaults * to yes. * - * @return Returns the div created. + * @returns object Returns the div created. */ phpbb.alert = function(title, msg, fadedark) { var div = $('<div class="jalert"><h3>' + title + '</h3><p>' + msg + '</p></div>'); @@ -95,7 +97,7 @@ phpbb.alert = function(title, msg, fadedark) { * @param bool fadedark Remove the dark background when done? Defaults * to yes. * - * @return Returns the div created. + * @returns object Returns the div created. */ phpbb.confirm = function(msg, callback, fadedark) { var div = $('<div class="jalert"><p>' + msg + '</p>\ @@ -173,7 +175,7 @@ phpbb.parse_querystring = function(string) { */ phpbb.ajaxify = function(options, refresh, callback) { - //private function to handle refreshes + // Private function to handle refreshes function handle_refresh(data, refresh, div) { if (!data) @@ -221,9 +223,7 @@ phpbb.ajaxify = function(options, refresh, callback) { { if (typeof res.S_CONFIRM_ACTION === 'undefined') { - /** - * It is a standard link, no confirm_box required. - */ + // It is a standard link, no confirm_box required. var alert = phpbb.alert(res.MESSAGE_TITLE, res.MESSAGE_TEXT); callback = phpbb.ajax_callbacks[callback]; if (typeof callback === 'function') @@ -234,9 +234,7 @@ phpbb.ajaxify = function(options, refresh, callback) { } else { - /** - * confirm_box - confirm with the user and send back - */ + // confirm_box - confirm with the user and send back phpbb.confirm(res.MESSAGE_TEXT, function(del) { if (del) { @@ -394,4 +392,4 @@ phpbb.ajaxify({ }, true); -})(jQuery); //avoid conflicts with other libraries +})(jQuery); // Avoid conflicts with other libraries |