Enhancements in the backend_settings.js comments.

This commit is contained in:
Alex Tselegidis 2016-05-14 12:51:12 +02:00
parent c3b7ea9383
commit 32c39a02a1

View file

@ -12,9 +12,10 @@
window.BackendSettings = window.BackendSettings || {}; window.BackendSettings = window.BackendSettings || {};
/** /**
* Contains the functionality of the backend settings page. Can either work for * Backend Settings
* system or user settings, but the actions allowed to the user are restricted to *
* his role (only admin has full privileges). * Contains the functionality of the backend settings page. Can either work for system or user settings,
* but the actions allowed to the user are restricted to his role (only admin has full privileges).
* *
* @module BackendSettings * @module BackendSettings
*/ */
@ -27,24 +28,23 @@ window.BackendSettings = window.BackendSettings || {};
exports.SETTINGS_USER = 'SETTINGS_USER'; exports.SETTINGS_USER = 'SETTINGS_USER';
/** /**
* Use this WorkingPlan class instance to perform actions on the page's working plan * Use this WorkingPlan class instance to perform actions on the page's working plan tables.
* tables. *
* @type {WorkingPlan}
*/ */
exports.wp = {}; exports.wp = {};
/** /**
* Tab settings object. * Tab settings object.
* *
* @type {object} * @type {Object}
*/ */
var settings = {}; var settings = {};
/** /**
* Initialize Page * Initialize Page
* *
* @param {bool} bindEventHandlers (OPTIONAL)Determines whether to bind the default event * @param {bool} bindEventHandlers Optional (true), determines whether to bind the default event handlers.
* handlers (default = true).
* @returns {undefined}
*/ */
exports.initialize = function(bindEventHandlers) { exports.initialize = function(bindEventHandlers) {
bindEventHandlers = bindEventHandlers || true; bindEventHandlers = bindEventHandlers || true;
@ -125,8 +125,9 @@ window.BackendSettings = window.BackendSettings || {};
}; };
/** /**
* Bind the backend/settings default event handlers. This method depends on the * Bind the backend/settings default event handlers.
* backend/settings html, so do not use this method on a different page. *
* This method depends on the backend/settings html, so do not use this method on a different page.
*/ */
function _bindEventHandlers() { function _bindEventHandlers() {
exports.wp.bindEventHandlers(); exports.wp.bindEventHandlers();