Enhancements in the backend_settings_system.js comments.

This commit is contained in:
Alex Tselegidis 2016-05-14 12:53:11 +02:00
parent 628e208804
commit 6540335e0a

View file

@ -14,16 +14,18 @@
'use strict'; 'use strict';
/** /**
* "System Settings" Tab Helper * "System Settings" Tab Helper Class
*
* @class SystemSettings * @class SystemSettings
*/ */
var SystemSettings = function() {}; var SystemSettings = function() {};
/** /**
* Save the system settings. This method is run after changes are detected on the * Save the system settings.
* tab input fields.
* *
* @param {array} settings Contains the system settings data. * This method is run after changes are detected on the tab input fields.
*
* @param {Array} settings Contains the system settings data.
*/ */
SystemSettings.prototype.save = function(settings) { SystemSettings.prototype.save = function(settings) {
var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_save_settings', var postUrl = GlobalVariables.baseUrl + '/index.php/backend_api/ajax_save_settings',
@ -52,10 +54,11 @@
}; };
/** /**
* Prepare the system settings array. This method uses the DOM elements of the * Prepare the system settings array.
* backend/settings page, so it can't be used in another page.
* *
* @returns {array} Returns the system settings array. * This method uses the DOM elements of the backend/settings page, so it can't be used in another page.
*
* @return {Array} Returns the system settings array.
*/ */
SystemSettings.prototype.get = function() { SystemSettings.prototype.get = function() {
var settings = []; var settings = [];
@ -93,10 +96,11 @@
}; };
/** /**
* Validate the settings data. If the validation fails then display a * Validate the settings data.
* message to the user.
* *
* @returns {bool} Returns the validation result. * If the validation fails then display a message to the user.
*
* @return {Boolean} Returns the validation result.
*/ */
SystemSettings.prototype.validate = function() { SystemSettings.prototype.validate = function() {
$('#general .required').css('border', ''); $('#general .required').css('border', '');