From 439e43fad92c747b0b37efae43c42a68963589f4 Mon Sep 17 00:00:00 2001
From: severin <muengers@student.ethz.ch>
Date: Fri, 21 Feb 2014 00:23:35 +0100
Subject: [PATCH] Began with class documentation

---
 .../wsf_js_widget/kernel/dropdown/wsf_dropdown_control.e   | 5 ++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_basic_control.e    | 6 +++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_button_control.e   | 5 ++++-
 .../library/wsf_js_widget/kernel/webcontrol/wsf_control.e  | 5 ++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_form_control.e     | 5 ++++-
 .../kernel/webcontrol/wsf_form_element_control.e           | 6 +++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_html_control.e     | 6 +++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_json_object.e      | 4 +++-
 .../wsf_js_widget/kernel/webcontrol/wsf_layout_control.e   | 5 ++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_multi_control.e    | 5 ++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_page_control.e     | 6 +++++-
 .../kernel/webcontrol/wsf_stateless_control.e              | 7 ++++++-
 .../kernel/webcontrol/wsf_stateless_multi_control.e        | 5 ++++-
 .../wsf_js_widget/kernel/webcontrol/wsf_value_control.e    | 5 ++++-
 .../wsf_js_widget/kernel/widgets/wsf_date_picker_control.e | 5 ++++-
 15 files changed, 65 insertions(+), 15 deletions(-)

diff --git a/draft/library/wsf_js_widget/kernel/dropdown/wsf_dropdown_control.e b/draft/library/wsf_js_widget/kernel/dropdown/wsf_dropdown_control.e
index 55576f21..a768b1a4 100644
--- a/draft/library/wsf_js_widget/kernel/dropdown/wsf_dropdown_control.e
+++ b/draft/library/wsf_js_widget/kernel/dropdown/wsf_dropdown_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_DROPDOWN_CONTROL}."
+	description: "[
+		Represents a bootstrap dropdown control. This class contains
+		facilities to add items or dividers.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_basic_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_basic_control.e
index 0cc5969c..256fcc63 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_basic_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_basic_control.e
@@ -1,5 +1,9 @@
 note
-	description: "Summary description for {WSF_BASIC_CONTROL}."
+	description: "[
+		Represents a simple basic element with a user specified html tag.
+		This control is lightweight and can be used to create custom
+		stateless controls, e.g. headers.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_button_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_button_control.e
index 5692d9ad..7f24b7a1 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_button_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_button_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_BUTTON_CONTROL}."
+	description: "[
+		Represents a button control (button html keyword). Provides a
+		callback agent which will be invoked when the button is clicked.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_control.e
index b6808e35..9caf4da9 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_CONTROL}."
+	description: "[
+			This class is the base class for all stateful controls, like
+			buttons or forms.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_control.e
index 46029fbd..7a342252 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_FORM_CONTROL}."
+	description: "[
+		Represents a standard html form. Provides facilities for
+		validation.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_element_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_element_control.e
index a3786a3b..07e368ea 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_element_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_form_element_control.e
@@ -1,5 +1,9 @@
 note
-	description: "Summary description for {WSF_FORM_ELEMENT_CONTROL}."
+	description: "[
+		A container class which encapsulates a form element (like input
+		fields) and, optionally, the corresponding validators and an
+		optional label.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_html_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_html_control.e
index 5e460fec..a8a6f168 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_html_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_html_control.e
@@ -1,5 +1,9 @@
 note
-	description: "Summary description for {WSF_html_CONTROL}."
+	description: "[
+		A convenience class that can be used to insert custom html code.
+		This class is a value control which means that the html text can
+		be updated.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_json_object.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_json_object.e
index c125181c..e845b316 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_json_object.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_json_object.e
@@ -1,5 +1,7 @@
 note
-	description: "Summary description for {WSF_JSON_OBJECT}."
+	description: "[
+		Advanced implementation of JSON_OBJECT with some helper	functions.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_layout_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_layout_control.e
index bc09d201..8bb6128f 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_layout_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_layout_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_LAYOUT_CONTROL}."
+	description: "[
+			A lightweight layout container to encapsulate the grid layout
+			provided by bootstrap.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_multi_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_multi_control.e
index 1b9b3800..d09c6ccd 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_multi_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_multi_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_MULTI_CONTROL}."
+	description: "[
+		Mutli controls are used as containers for multiple controls, for
+		example a form is a multi control.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_page_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_page_control.e
index d5621f21..4dbf032b 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_page_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_page_control.e
@@ -1,5 +1,9 @@
 note
-	description: "Summary description for {WSF_PAGE_CONTROL}."
+	description: "[
+			The skeleton for a page control which represents a single page
+			of the web application. This class is the starting point for
+			event distribution, rendering and state handling.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_control.e
index 3d9b2e1e..f7c4508e 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_control.e
@@ -1,5 +1,10 @@
 note
-	description: "Summary description for {WSF_STATELESS_CONTROL}."
+	description: "[
+		This class is the base class of the framework.
+		Stateless controls are HTML elements which have no state (e.g.
+		headers, layout containers or static text fields. Stateful
+		controls (WSF_CONTROL) are subtypes	of this class.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_multi_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_multi_control.e
index 2dfe1ee9..cf4b4ae8 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_multi_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_stateless_multi_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_STATELESS_MULTI_CONTROL}."
+	description: "[
+			Mutli controls are used as containers for multiple controls, for
+			example a form is a multi control.
+			]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_value_control.e b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_value_control.e
index 44b940c0..009c136e 100644
--- a/draft/library/wsf_js_widget/kernel/webcontrol/wsf_value_control.e
+++ b/draft/library/wsf_js_widget/kernel/webcontrol/wsf_value_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_VALUE_CONTROL}."
+	description: "[
+		Controls that can store a value inherit from this class.
+		Such controls are for example input fields, buttons or checkboxes.
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"
diff --git a/draft/library/wsf_js_widget/kernel/widgets/wsf_date_picker_control.e b/draft/library/wsf_js_widget/kernel/widgets/wsf_date_picker_control.e
index 720ed9ed..55bb3150 100644
--- a/draft/library/wsf_js_widget/kernel/widgets/wsf_date_picker_control.e
+++ b/draft/library/wsf_js_widget/kernel/widgets/wsf_date_picker_control.e
@@ -1,5 +1,8 @@
 note
-	description: "Summary description for {WSF_DATETIME_PICKER_CONTROL}."
+	description: "[
+		A very basic datepicker widget based on the datepicker from
+		Stefan Petre (http://www.eyecon.ro/bootstrap-datepicker).
+	]"
 	author: ""
 	date: "$Date$"
 	revision: "$Revision$"