1 files changed, 39 insertions, 75 deletions
diff --git a/phpBB/assets/javascript/plupload.js b/phpBB/assets/javascript/plupload.js
index e0d2e05a84..a80e816569 100644
--- a/phpBB/assets/javascript/plupload.js
+++ b/phpBB/assets/javascript/plupload.js
@@ -7,8 +7,6 @@ phpbb.plupload.ids = [];
 
 /**
  * Set up the uploader.
- *
- * @return undefined
  */
 phpbb.plupload.initialize = function() {
 	// Initialize the Plupload uploader.
@@ -48,8 +46,6 @@ phpbb.plupload.initialize = function() {
 /**
  * Unsets all elements in the object uploader.settings.multipart_params whose keys
  * begin with 'attachment_data['
- *
- * @return undefined
  */
 phpbb.plupload.clearParams = function() {
 	var obj = phpbb.plupload.uploader.settings.multipart_params;
@@ -65,8 +61,7 @@ phpbb.plupload.clearParams = function() {
 /**
  * Update uploader.settings.multipart_params object with new data.
  *
- * @param object obj
- * @return undefined
+ * @param {object} obj
  */
 phpbb.plupload.updateMultipartParams = function(obj) {
 	phpbb.plupload.uploader.settings.multipart_params = $.extend(
@@ -78,7 +73,7 @@ phpbb.plupload.updateMultipartParams = function(obj) {
 /**
  * Convert the array of attachment objects into an object that PHP would expect as POST data.
  *
- * @return object An object in the form 'attachment_data[i][key]': value as
+ * @returns {object} An object in the form 'attachment_data[i][key]': value as
  * 	expected by the server
  */
 phpbb.plupload.getSerializedData = function() {
@@ -100,9 +95,8 @@ phpbb.plupload.getSerializedData = function() {
  * Get the index from the phpbb.plupload.data array where the given
  * attachment id appears.
  *
- * @param int attach_id The attachment id of the file.
- * @return bool	Returns false if the id cannot be found.
- * @return int	Returns the index of the file if it exists.
+ * @param {int} attach_id The attachment id of the file.
+ * @returns {bool|int} Index of the file if exists, otherwise false.
  */
 phpbb.plupload.getIndex = function(attach_id) {
 	var index = $.inArray(Number(attach_id), phpbb.plupload.ids);
@@ -112,10 +106,8 @@ phpbb.plupload.getIndex = function(attach_id) {
 /**
  * Set the data in phpbb.plupload.data and phpbb.plupload.ids arrays.
  * 
- * @param array data	Array containing the new data to use. In the form of 
+ * @param {Array} data	Array containing the new data to use. In the form of
  * array(index => object(property: value). Requires attach_id to be one of the object properties.
- *
- * @return undefined
  */
 phpbb.plupload.setData = function(data) {
 	// Make sure that the array keys are reset.
@@ -130,11 +122,10 @@ phpbb.plupload.setData = function(data) {
 /**
  * Update the attachment data in the HTML and the phpbb & phpbb.plupload objects.
  * 
- * @param array data		Array containing the new data to use.
- * @param string action		The action that required the update. Used to update the inline attachment bbcodes.
- * @param int index			The index from phpbb.plupload_ids that was affected by the action.
- * @param array downloadUrl	Optional array of download urls to update.
- * @return undefined
+ * @param {Array} data			Array containing the new data to use.
+ * @param {string} action		The action that required the update. Used to update the inline attachment bbcodes.
+ * @param {int} index			The index from phpbb.plupload_ids that was affected by the action.
+ * @param {Array} downloadUrl	Optional array of download urls to update.
  */
 phpbb.plupload.update = function(data, action, index, downloadUrl) {
 
@@ -148,8 +139,7 @@ phpbb.plupload.update = function(data, action, index, downloadUrl) {
 /**
  * Update the relevant elements and hidden data for all attachments.
  * 
- * @param array downloadUrl	Optional array of download urls to update.
- * @return undefined
+ * @param {Array} downloadUrl Optional array of download urls to update.
  */
 phpbb.plupload.updateRows = function(downloadUrl) {
 	for (var i = 0; i < phpbb.plupload.ids.length; i++) {
@@ -163,9 +153,8 @@ phpbb.plupload.updateRows = function(downloadUrl) {
  * data for the file inserted into it. The row is then appended or prepended to
  * #file-list based on the attach_order setting.
  * 
- * @param object file	Plupload file object for the new attachment.
- * @return undefined
- */
+ * @param {object} file Plupload file object for the new attachment.
+ */{}
 phpbb.plupload.insertRow = function(file) {
 	var row = $(phpbb.plupload.rowTpl);
 
@@ -183,9 +172,8 @@ phpbb.plupload.insertRow = function(file) {
 /**
  * Update the relevant elements and hidden data for an attachment.
  * 
- * @param int index	The index from phpbb.plupload.ids of the attachment to edit.
- * @param array downloadUrl	Optional array of download urls to update. 
- * @return undefined
+ * @param {int} index The index from phpbb.plupload.ids of the attachment to edit.
+ * @param {Array} downloadUrl Optional array of download urls to update.
  */
 phpbb.plupload.updateRow = function(index, downloadUrl) {
 	var attach = phpbb.plupload.data[index],
@@ -194,7 +182,7 @@ phpbb.plupload.updateRow = function(index, downloadUrl) {
 	// Add the link to the file
 	if (typeof downloadUrl !== 'undefined' && typeof downloadUrl[index] !== 'undefined') {
 		var url = downloadUrl[index].replace('&amp;', '&'),
-			link = $('<a></a>');
+			link = ${('}<a></a>');
 
 		link.attr('href', url).html(attach.real_filename);
 		row.find('.file-name').html(link)	
@@ -207,10 +195,9 @@ phpbb.plupload.updateRow = function(index, downloadUrl) {
 /**
  * Update hidden input data for an attachment.
  *
- * @param object row	jQuery object for the attachment row.
- * @param object attach	Attachment data object from phpbb.plupload.data
- * @param int index		Attachment index from phpbb.plupload.ids
- * @return undefined
+ * @param {object} row		jQuery object for the attachment row.
+ * @param {object} attach	Attachment data object from phpbb.plupload.data
+ * @param {int} index		Attachment index from phpbb.plupload.ids
  */
 phpbb.plupload.updateHiddenData = function(row, attach, index) {
 	row.find('input[type="hidden"]').remove();
@@ -230,10 +217,8 @@ phpbb.plupload.updateHiddenData = function(row, attach, index) {
  * responds with the updated attachment data list so that any future
  * uploads can maintain state with the server
  *
- * @param object row	jQuery object for the attachment row.
- * @param int attachId	Attachment id of the file to be removed.
- *
- * @return undefined
+ * @param {object} row		jQuery object for the attachment row.
+ * @param {int} attachId	Attachment id of the file to be removed.
  */
 phpbb.plupload.deleteFile = function(row, attachId) {
 	// If there's no attach id, then the file hasn't been uploaded. Simply delete the row.
@@ -300,8 +285,6 @@ phpbb.plupload.deleteFile = function(row, attachId) {
 
 /**
  * Check the attachment list and hide its container if it's empty.
- *
- * @return undefined
  */
 phpbb.plupload.hideEmptyList = function() {
 	if (!$('#file-list').children().length) {
@@ -315,10 +298,8 @@ phpbb.plupload.hideEmptyList = function() {
  * before the phpbb.plupload,data and phpbb.plupload.ids arrays are updated, otherwise it will
  * not work correctly.
  *
- * @param string action	The action that occurred -- either "addition" or "removal"
- * @param int index		The index of the attachment from phpbb.plupload.ids that was affected.
- *
- * @return undefined
+ * @param {string} action	The action that occurred -- either "addition" or "removal"
+ * @param {int} index		The index of the attachment from phpbb.plupload.ids that was affected.
  */
 phpbb.plupload.updateBbcode = function(action, index) {
 	var	textarea = $('#message', phpbb.plupload.form),
@@ -366,10 +347,10 @@ phpbb.plupload.updateBbcode = function(action, index) {
 /**
  * Get Plupload file objects based on their upload status.
  *
- * @param int status Plupload status - plupload.DONE, plupload.FAILED, plupload.QUEUED,
- * plupload.STARTED, plupload.STOPPED
+ * @param {int} status Plupload status - plupload.DONE, plupload.FAILED,
+ * plupload.QUEUED, plupload.STARTED, plupload.STOPPED
  *
- * @return Returns an array of the Plupload file objects matching the status.
+ * @returns {Array} The Plupload file objects matching the status.
  */
 phpbb.plupload.getFilesByStatus = function(status) {
 	var files = [];
@@ -387,7 +368,7 @@ phpbb.plupload.getFilesByStatus = function(status) {
  * to upload. If so, disables the uploader and marks the queued files as failed. Otherwise
  * makes sure that the uploader is enabled.
  *
- * @return bool Returns true if the limit has been reached. False if otherwise.
+ * @returns {bool} True if the limit has been reached. False if otherwise.
  */
 phpbb.plupload.handleMaxFilesReached = function() {
 	// If there is no limit, the user is an admin or moderator.
@@ -412,8 +393,6 @@ phpbb.plupload.handleMaxFilesReached = function() {
 
 /**
  * Disable the uploader
- *
- * @return undefined
  */
 phpbb.plupload.disableUploader = function() {
 	$('#add_files').addClass('disabled');
@@ -422,8 +401,6 @@ phpbb.plupload.disableUploader = function() {
 
 /**
  * Enable the uploader
- *
- * @return undefined
  */
 phpbb.plupload.enableUploader = function() {
 	$('#add_files').removeClass('disabled');
@@ -433,8 +410,7 @@ phpbb.plupload.enableUploader = function() {
 /**
  * Mark all queued files as failed.
  *
- * @param string error Error message to present to the user.
- * @return undefined
+ * @param {string} error Error message to present to the user.
  */
 phpbb.plupload.markQueuedFailed = function(error) {
 	var files = phpbb.plupload.getFilesByStatus(plupload.QUEUED);
@@ -448,9 +424,8 @@ phpbb.plupload.markQueuedFailed = function(error) {
 /**
  * Marks a file as failed and sets the error message for it.
  *
- * @param object file	Plupload file object that failed.
- * @param string error	Error message to present to the user.
- * @return undefined
+ * @param {object} file		Plupload file object that failed.
+ * @param {string} error	Error message to present to the user.
  */
 phpbb.plupload.fileError = function(file, error) {
 	file.status = plupload.FAILED;
@@ -520,11 +495,8 @@ phpbb.plupload.uploader.bind('Error', function(up, error) {
  * send the real filename along with the chunk. This is necessary because
  * for some reason the filename is set to 'blob' whenever a file is chunked
  *
- * @param object up		The plupload.Uploader object
- * @param object file	The plupload.File object that is about to be
- * 	uploaded
- *
- * @return undefined
+ * @param {object} up	The plupload.Uploader object
+ * @param {object} file	The plupload.File object that is about to be uploaded
  */
 phpbb.plupload.uploader.bind('BeforeUpload', function(up, file) {
 	if (phpbb.plupload.handleMaxFilesReached()) {
@@ -539,12 +511,10 @@ phpbb.plupload.uploader.bind('BeforeUpload', function(up, file) {
  * response from the server and checks for an error. If an error occurs it
  * is reported to the user and the upload of this particular file is halted
  *
- * @param object up			The plupload.Uploader object
- * @param object file		The plupload.File object whose chunk has just
+ * @param {object} up		The plupload.Uploader object
+ * @param {object} file		The plupload.File object whose chunk has just
  * 	been uploaded
- * @param object response	The response object from the server
- *
- * @return undefined
+ * @param {object} response	The response object from the server
  */
 phpbb.plupload.uploader.bind('ChunkUploaded', function(up, file, response) {
 	if (response.chunk >= response.chunks - 1) {
@@ -584,8 +554,6 @@ phpbb.plupload.uploader.bind('ChunkUploaded', function(up, file, response) {
 
 /**
  * Fires when files are added to the queue.
- *
- * @return undefined
  */
 phpbb.plupload.uploader.bind('FilesAdded', function(up, files) {
 	// Prevent unnecessary requests to the server if the user already uploaded
@@ -627,12 +595,10 @@ phpbb.plupload.uploader.bind('FilesAdded', function(up, files) {
  * appends it to the next file upload so that the server can maintain state
  * with regards to the attachments in a given post
  *
- * @param object up			The plupload.Uploader object
- * @param object file		The plupload.File object that has just been
+ * @param {object} up		The plupload.Uploader object
+ * @param {object} file		The plupload.File object that has just been
  * 	uploaded
- * @param string response	The response string from the server
- *
- * @return undefined
+ * @param {string} response	The response string from the server
  */
 phpbb.plupload.uploader.bind('FileUploaded', function(up, file, response) {
 	var json = {},
@@ -674,11 +640,9 @@ phpbb.plupload.uploader.bind('FileUploaded', function(up, file, response) {
 /**
  * Fires when the entire queue of files have been uploaded. 
  *
- * @param object up		The plupload.Uploader object
- * @param array files	An array of plupload.File objects that have just
+ * @param {object} up	The plupload.Uploader object
+ * @param {Array} files	An array of plupload.File objects that have just
  * 	been uploaded as part of a queue
- *
- * @return undefined
  */
 phpbb.plupload.uploader.bind('UploadComplete', function(up, files) {
 	// Hide the progress bar