From: Emmanuel Kasper <e.kasper@proxmox.com>
Date: Thu, 28 May 2015 09:56:27 +0000 (+0200)
Subject: Add comment header for important classes, idea taken from Workspace.js
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=5289a1b81aac9cfa3b7c8cca38034e2298d0a219;p=pve-manager.git

Add comment header for important classes, idea taken from Workspace.js
---

diff --git a/www/manager5/dc/Config.js b/www/manager5/dc/Config.js
index aa9c0f8a..d929085a 100644
--- a/www/manager5/dc/Config.js
+++ b/www/manager5/dc/Config.js
@@ -1,3 +1,7 @@
+/*
+ * Main config panel, located in Center of the ViewPort
+ */
+
 Ext.define('PVE.dc.Config', {
     extend: 'PVE.panel.Config',
     alias: 'widget.PVE.dc.Config',
diff --git a/www/manager5/dc/Log.js b/www/manager5/dc/Log.js
index f3db5d4c..4bd76b77 100644
--- a/www/manager5/dc/Log.js
+++ b/www/manager5/dc/Log.js
@@ -1,3 +1,7 @@
+/* This class defines the "Cluster log" tab of the bottom status panel
+ * A log entry is a timestamp associated with an action on a cluster
+ */
+
 Ext.define('PVE.dc.Log', {
     extend: 'Ext.grid.GridPanel',
 
diff --git a/www/manager5/dc/Tasks.js b/www/manager5/dc/Tasks.js
index 25fd51b0..1e81ef7f 100644
--- a/www/manager5/dc/Tasks.js
+++ b/www/manager5/dc/Tasks.js
@@ -1,3 +1,7 @@
+/* This class defines the "Tasks" tab of the bottom status panel
+ * Tasks are jobs with a start, end and log output
+ */
+
 Ext.define('PVE.dc.Tasks', {
     extend: 'Ext.grid.GridPanel',
 
diff --git a/www/manager5/form/ViewSelector.js b/www/manager5/form/ViewSelector.js
index 1a623b86..74f45075 100644
--- a/www/manager5/form/ViewSelector.js
+++ b/www/manager5/form/ViewSelector.js
@@ -1,3 +1,6 @@
+/*
+ * Top left combobox, used to select a view of the underneath RessourceTree
+ */
 Ext.define('PVE.form.ViewSelector', {
     extend: 'Ext.form.field.ComboBox',
     alias: ['widget.pveViewSelector'],
diff --git a/www/manager5/panel/StatusPanel.js b/www/manager5/panel/StatusPanel.js
index 0c5beb45..92d4d99e 100644
--- a/www/manager5/panel/StatusPanel.js
+++ b/www/manager5/panel/StatusPanel.js
@@ -1,3 +1,6 @@
+/*
+ * This class describes the bottom panel
+ */
 Ext.define('PVE.panel.StatusPanel', {
     extend: 'Ext.tab.Panel',
     alias: 'widget.pveStatusPanel',
diff --git a/www/manager5/tree/ResourceTree.js b/www/manager5/tree/ResourceTree.js
index ca7691b8..48c1da66 100644
--- a/www/manager5/tree/ResourceTree.js
+++ b/www/manager5/tree/ResourceTree.js
@@ -1,3 +1,6 @@
+/*
+ * Left Treepanel, containing all the ressources we manage in this datacenter: server nodes, server storages, VMs and Containers
+ */
 Ext.define('PVE.tree.ResourceTree', {
     extend: 'Ext.tree.TreePanel',
     alias: ['widget.pveResourceTree'],