[Lada-commits] [PATCH 2 of 3] Added docstrings

[Wald Commits]

# HG changeset patch
# User Torsten Irländer <torsten.irlaender at intevation.de>
# Date 1375969588 -7200
# Node ID dec0893d38e3fe60b583e6a71a95c2ecf5edb85e
# Parent  ee5767cd2dded4dae8cf8766dcaf91caa6ef7810
Added docstrings

diff -r ee5767cd2dde -r dec0893d38e3 app/view/widgets/LadaForm.js
--- a/app/view/widgets/LadaForm.js	Thu Aug 08 11:29:56 2013 +0200
+++ b/app/view/widgets/LadaForm.js	Thu Aug 08 15:46:28 2013 +0200
@@ -1,10 +1,15 @@
+/**
+ * Generic Lada specific form.
+ *
+ * See http://moduscreate.com/expert-ext-js-model-integration-in-forms/ for
+ * more details
+ */
 Ext.define('Lada.view.widgets.LadaForm', {
     extend: 'Ext.form.Panel',
 
     alias: 'widget.ladaform',
-    /**
-     * http://moduscreate.com/expert-ext-js-model-integration-in-forms/
-     */
+    bodyPadding: '10 10',
+    border: 0,
 
     /**
      * Can be a reference to a model instance or a model class name.
@@ -15,13 +20,26 @@
      * Only applicable if model provided is a model class name (string).
      */
     modelId: null,
-    bodyPadding: '10 10',
-    border: 0,
-
+    /**
+     * List of errors in the form. Typically set after the server validates the form submission
+     */
     errors: null,
+    /**
+     * List of warnings in the form. Typically set after the server validates the form submission
+     */
     warnings: null,
+    /**
+     * The generic (error) message for the form. Typically set after the server validates the form submission
+     */
     message: null,
+    /**
+     * Flag to indicate if the validation succeeds. Typically set after the server validates the form submission
+     */
     success: null,
+    /**
+     * Flag to indicate if the form should be rendered in readonly mode. Will
+     * be set after calling the {setReadOnly} function.
+     */
     readonly: false,
 
     initComponent: function() {