[Lada-commits] [PATCH 08 of 13] Added documentation

[Wald Commits]

# HG changeset patch
# User Torsten Irländer <torsten.irlaender at intevation.de>
# Date 1376386487 -7200
# Node ID 6007d11b81c27a446f86b03ff8e62ac344c60536
# Parent  1536fb5c81b7150465c374d2f609379a0eb77fcb
Added documentation

diff -r 1536fb5c81b7 -r 6007d11b81c2 app/view/proben/Create.js
--- a/app/view/proben/Create.js	Tue Aug 13 11:23:51 2013 +0200
+++ b/app/view/proben/Create.js	Tue Aug 13 11:34:47 2013 +0200
@@ -1,3 +1,6 @@
+/*
+ * Window to create a Probe
+ */
 Ext.define('Lada.view.proben.Create', {
     extend: 'Ext.window.Window',
     alias: 'widget.probencreate',
diff -r 1536fb5c81b7 -r 6007d11b81c2 app/view/proben/CreateForm.js
--- a/app/view/proben/CreateForm.js	Tue Aug 13 11:23:51 2013 +0200
+++ b/app/view/proben/CreateForm.js	Tue Aug 13 11:34:47 2013 +0200
@@ -1,3 +1,6 @@
+/*
+ * Formular to create a Probe
+ */
 Ext.define('Lada.view.proben.CreateForm', {
     extend: 'Lada.view.widgets.LadaForm',
     requires: [
diff -r 1536fb5c81b7 -r 6007d11b81c2 app/view/proben/Edit.js
--- a/app/view/proben/Edit.js	Tue Aug 13 11:23:51 2013 +0200
+++ b/app/view/proben/Edit.js	Tue Aug 13 11:34:47 2013 +0200
@@ -1,3 +1,6 @@
+/*
+ * Window to edit a Probe
+ */
 Ext.define('Lada.view.proben.Edit', {
     extend: 'Ext.window.Window',
     alias: 'widget.probenedit',
diff -r 1536fb5c81b7 -r 6007d11b81c2 app/view/proben/EditForm.js
--- a/app/view/proben/EditForm.js	Tue Aug 13 11:23:51 2013 +0200
+++ b/app/view/proben/EditForm.js	Tue Aug 13 11:34:47 2013 +0200
@@ -1,3 +1,6 @@
+/*
+ * Formular to edit a Probe
+ */
 Ext.define('Lada.view.proben.EditForm', {
     extend: 'Lada.view.widgets.LadaForm',
     requires: [
diff -r 1536fb5c81b7 -r 6007d11b81c2 app/view/proben/List.js
--- a/app/view/proben/List.js	Tue Aug 13 11:23:51 2013 +0200
+++ b/app/view/proben/List.js	Tue Aug 13 11:34:47 2013 +0200
@@ -1,3 +1,6 @@
+/*
+ * Grid to list Proben
+ */
 Ext.define('Lada.view.proben.List' ,{
     extend: 'Ext.grid.Panel',
     alias: 'widget.probenlist',
@@ -39,6 +42,12 @@
         this.columns = [];
         this.callParent(arguments);
     },
+    /**
+     * Setup columns of the Grid dynamically based on a list of given cols.
+     * The function is called from the {@link Lada.controllers.Sql#selectSql
+     * select sql event}
+     * @parameter {Array} List of cols to show in the Grid.
+     */
     setupColumns: function(cols) {
         var rcols = []
         rcols.push({header: 'RW', dataIndex: 'readonly', width: 30, renderer: render_readonly});
@@ -49,6 +58,10 @@
     }
 });
 
+/**
+ * Helper function to render a readonly symbol per row in the grid
+ * @param {Boolean} flag if the symbol is a readonly symbol.
+ */
 function render_readonly (value) {
     if (value) {
         return '🔒'