Add documentation to all IGUIElement's which events they are creating.

git-svn-id: svn://svn.code.sf.net/p/irrlicht/code/trunk@4235 dfc29bdd-3216-0410-991c-e03cc46cb475

include/IGUIButton.h

@@ -52,6 +52,9 @@ namespace gui
 	};
 
 	//! GUI Button interface.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_BUTTON_CLICKED
+	*/
 	class IGUIButton : public IGUIElement
 	{
 	public:

include/IGUICheckBox.h

@@ -13,6 +13,9 @@ namespace gui
 {
 
 	//! GUI Check box interface.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_CHECKBOX_CHANGED
+	*/
 	class IGUICheckBox : public IGUIElement
 	{
 	public:

include/IGUIComboBox.h

@@ -13,6 +13,9 @@ namespace gui
 {
 
 	//! Combobox widget
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_COMBO_BOX_CHANGED
+	*/
 	class IGUIComboBox : public IGUIElement
 	{
 	public:

include/IGUIContextMenu.h

@@ -28,6 +28,10 @@ namespace gui
 	};
 
 	//! GUI Context menu interface.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_ELEMENT_CLOSED
+	\li EGET_MENU_ITEM_SELECTED
+	*/
 	class IGUIContextMenu : public IGUIElement
 	{
 	public:

include/IGUIEditBox.h

@@ -15,6 +15,11 @@ namespace gui
 	class IGUIFont;
 
 	//! Single line edit box for editing simple text.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_EDITBOX_ENTER
+	\li EGET_EDITBOX_CHANGED
+	\li EGET_EDITBOX_MARKING_CHANGED
+	*/
 	class IGUIEditBox : public IGUIElement
 	{
 	public:

include/IGUIEnvironment.h

@@ -61,6 +61,12 @@ class IGUIWindow;
 class IGUIElementFactory;
 
 //! GUI Environment. Used as factory and manager of all other GUI elements.
+/** \par This element can create the following events of type EGUI_EVENT_TYPE (which are passed on to focused sub-elements):
+\li EGET_ELEMENT_FOCUS_LOST
+\li EGET_ELEMENT_FOCUSED
+\li EGET_ELEMENT_LEFT
+\li EGET_ELEMENT_HOVERED
+*/
 class IGUIEnvironment : public virtual IReferenceCounted
 {
 public:

include/IGUIFileOpenDialog.h

@@ -14,7 +14,13 @@ namespace gui
 {
 
 	//! Standard file chooser dialog.
-	/** When the user selects a folder this does change the current working directory  */
+	/** \warning When the user selects a folder this does change the current working directory
+
+	\par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_DIRECTORY_SELECTED
+	\li EGET_FILE_SELECTED
+	\li EGET_FILE_CHOOSE_DIALOG_CANCELLED
+	*/
 	class IGUIFileOpenDialog : public IGUIElement
 	{
 	public:

include/IGUIListBox.h

@@ -31,6 +31,10 @@ namespace gui
 
 
 	//! Default list box GUI element.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_LISTBOX_CHANGED
+	\li EGET_LISTBOX_SELECTED_AGAIN
+	*/
 	class IGUIListBox : public IGUIElement
 	{
 	public:

include/IGUIScrollBar.h

@@ -13,6 +13,9 @@ namespace gui
 {
 
 	//! Default scroll bar GUI element.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_SCROLL_BAR_CHANGED
+	*/
 	class IGUIScrollBar : public IGUIElement
 	{
 	public:

include/IGUISpinBox.h

@@ -14,6 +14,9 @@ namespace gui
 	class IGUIEditBox;
 
 	//! Single line edit box + spin buttons
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_SPINBOX_CHANGED
+	*/
 	class IGUISpinBox : public IGUIElement
 	{
 	public:

include/IGUITabControl.h

@@ -49,6 +49,9 @@ namespace gui
 	};
 
 	//! A standard tab control
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_TAB_CHANGED
+	*/
 	class IGUITabControl : public IGUIElement
 	{
 	public:

include/IGUITreeView.h

@@ -17,6 +17,12 @@ namespace gui
 
 
 	//! Node for gui tree view
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_TREEVIEW_NODE_EXPAND
+	\li EGET_TREEVIEW_NODE_COLLAPS
+	\li EGET_TREEVIEW_NODE_DESELECT
+	\li EGET_TREEVIEW_NODE_SELECT
+	*/
 	class IGUITreeViewNode : public IReferenceCounted
 	{
 	public:

include/IGUIWindow.h

@@ -15,6 +15,9 @@ namespace gui
 	class IGUIButton;
 
 	//! Default moveable window GUI element with border, caption and close icons.
+	/** \par This element can create the following events of type EGUI_EVENT_TYPE:
+	\li EGET_ELEMENT_CLOSED
+	*/
 	class IGUIWindow : public IGUIElement
 	{
 	public:

scripts/doc/irrlicht/makedocumentation.bat

@@ -4,6 +4,9 @@ copy doxygen.css ..\..\..\doctemp\html
 copy irrlicht.png ..\..\..\doctemp\html
 copy logobig.png ..\..\..\doctemp\html
 
+rem enable following line for skipping tutorial generation (can be used for faster testing documentation layout)
+rem goto SKIP_TUTS
+
 rem for /F %%i in ('dir ..\..\..\examples\[01]*\main.cpp') DO ..\sed.exe -f tutorials.sed %i >>tut.txt
 ..\sed.exe -f tutorials.sed ..\..\..\examples\01.HelloWorld\main.cpp >tut.txt
 ..\sed.exe -f tutorials.sed ..\..\..\examples\02.Quake3Map\main.cpp >>tut.txt
@@ -32,6 +35,8 @@ rem for /F %%i in ('dir ..\..\..\examples\[01]*\main.cpp') DO ..\sed.exe -f tuto
 ..\sed.exe -f tutorials.sed ..\..\..\examples\25.XmlHandling\main.cpp >>tut.txt
 ..\sed.exe -f tutorials.sed ..\..\..\examples\26.OcclusionQuery\main.cpp >>tut.txt
 
+:SKIP_TUTS
+
 ..\doxygen.exe doxygen.cfg
 
 pause