Began with class documentation

This commit is contained in:
severin
2014-02-21 00:23:35 +01:00
parent 45ddc47b0e
commit 439e43fad9
15 changed files with 65 additions and 15 deletions

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"

View File

@@ -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$"