[pve-devel] [PATCH 4/4] Add comment header for important classes, idea taken from Workspace.js

Emmanuel Kasper e.kasper at proxmox.com
Thu May 28 11:56:27 CEST 2015


---
 www/manager5/dc/Config.js         | 4 ++++
 www/manager5/dc/Log.js            | 4 ++++
 www/manager5/dc/Tasks.js          | 4 ++++
 www/manager5/form/ViewSelector.js | 3 +++
 www/manager5/panel/StatusPanel.js | 3 +++
 www/manager5/tree/ResourceTree.js | 3 +++
 6 files changed, 21 insertions(+)

diff --git a/www/manager5/dc/Config.js b/www/manager5/dc/Config.js
index aa9c0f8..d929085 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 f3db5d4..4bd76b7 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 25fd51b..1e81ef7 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 1a623b8..74f4507 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 0c5beb4..92d4d99 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 ca7691b..48c1da6 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'],
-- 
2.1.4




More information about the pve-devel mailing list