Documentation updates.

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

include/IGUIContextMenu.h

@@ -39,7 +39,7 @@ namespace gui
 		//! set behaviour when menus are closed
 		virtual void setCloseHandling(ECONTEXT_MENU_CLOSE onClose) = 0;
 
-		//! get current behaviour when the menue will be closed
+		//! get current behaviour when the menu will be closed
 		virtual ECONTEXT_MENU_CLOSE getCloseHandling() const = 0;
 
 		//! Get amount of menu items
@@ -53,7 +53,7 @@ namespace gui
 		set to whatever you want.
 		\param enabled: Specifies if the menu item should be enabled.
 		\param hasSubMenu: Set this to true if there should be a submenu
-		at this item. You can acess this submenu via getSubMenu().
+		at this item. You can access this submenu via getSubMenu().
 		\param checked: Specifies if the menu item should be initially checked.
 		\return Returns the index of the new item */
 		virtual u32 addItem(const wchar_t* text, s32 commandId=-1, bool enabled=true,
@@ -69,16 +69,16 @@ namespace gui
 		set to whatever you want.
 		\param enabled: Specifies if the menu item should be enabled.
 		\param hasSubMenu: Set this to true if there should be a submenu
-		at this item. You can acess this submenu via getSubMenu().
+		at this item. You can access this submenu via getSubMenu().
 		\param checked: Specifies if the menu item should be initially checked.
 		\return Returns the index of the new item */
 		virtual u32 insertItem(u32 idx, const wchar_t* text, s32 commandId=-1, bool enabled=true,
 			bool hasSubMenu=false, bool checked=false, bool autoChecking=false) = 0;
 
-		//! Find an item by it's CommandID 
+		//! Find an item by it's CommandID
 		/**
 		\param commandId: We are looking for the first item which has this commandID
-		\param idxStartSearch: Start searching from this index. 
+		\param idxStartSearch: Start searching from this index.
         \return Returns the index of the item when found or otherwise -1. */
 		virtual s32 findItemWithCommandId(s32 commandId, u32 idxStartSearch=0) const = 0;
 

include/IGUIEditBox.h

@@ -38,7 +38,7 @@ namespace gui
 		\param color: New color of the text. */
 		virtual void setOverrideColor(video::SColor color) = 0;
 
-		//! Sets if the text should use the overide color or the color in the gui skin.
+		//! Sets if the text should use the override color or the color in the gui skin.
 		/** \param enable: If set to true, the override color, which can be set
 		with IGUIEditBox::setOverrideColor is used, otherwise the
 		EGDC_BUTTON_TEXT color of the skin. */
@@ -70,7 +70,7 @@ namespace gui
 		virtual void setMultiLine(bool enable) = 0;
 
 		//! Checks if multi line editing is enabled
-		/** \return true if mult-line is enabled, false otherwise */
+		/** \return true if multi-line is enabled, false otherwise */
 		virtual bool isMultiLineEnabled() const = 0;
 
 		//! Enables or disables automatic scrolling with cursor position

include/IGUIElementFactory.h

@@ -15,7 +15,7 @@ namespace gui
 {
 	class IGUIElement;
 
-	//! Interface making it possible to dynamicly create GUI elements
+	//! Interface making it possible to dynamically create GUI elements
 	/** To be able to add custom elements to Irrlicht and to make it possible for the
 	scene manager to save and load them, simply implement this interface and register it
 	in your gui environment via IGUIEnvironment::registerGUIElementFactory.

include/IGUIFont.h

@@ -44,7 +44,7 @@ public:
 	/** \param text: Text to draw
 	\param position: Rectangle specifying position where to draw the text.
 	\param color: Color of the text
-	\param hcenter: Specifiies if the text should be centered horizontally into the rectangle.
+	\param hcenter: Specifies if the text should be centered horizontally into the rectangle.
 	\param vcenter: Specifies if the text should be centered vertically into the rectangle.
 	\param clip: Optional pointer to a rectangle against which the text will be clipped.
 	If the pointer is null, no clipping will be done. */

include/IGUIInOutFader.h

@@ -44,14 +44,14 @@ namespace gui
 		/** In the beginning the whole rect is drawn by the set color
 		(black by default) and at the end of the overgiven time the
 		color has faded out.
-		\param time: Time specifing how long it should need to fade in,
+		\param time: Time specifying how long it should need to fade in,
 		in milliseconds. */
 		virtual void fadeIn(u32 time) = 0;
 
 		//! Starts the fade out process.
 		/** In the beginning everything is visible, and at the end of
 		the time only the set color (black by the fault) will be drawn.
-		\param time: Time specifing how long it should need to fade out,
+		\param time: Time specifying how long it should need to fade out,
 		in milliseconds. */
 		virtual void fadeOut(u32 time) = 0;
 

include/IGUISpriteBank.h

@@ -40,7 +40,7 @@ struct SGUISprite
 
 //! Sprite bank interface.
 /** See http://irrlicht.sourceforge.net/phpBB2/viewtopic.php?t=25742&highlight=spritebank
-* for more einformation how to use the spritebank.
+* for more information how to use the spritebank.
 */
 class IGUISpriteBank : public virtual IReferenceCounted
 {

include/IGUITabControl.h

@@ -13,7 +13,8 @@ namespace irr
 {
 namespace gui
 {
-	//! A tab, onto which other gui elements could be added.
+	//! A tab-page, onto which other gui elements could be added.
+	/** IGUITab refers to the page itself, not to the tab in the tabbar of an IGUITabControl. */
 	class IGUITab : public IGUIElement
 	{
 	public:
@@ -88,10 +89,10 @@ namespace gui
 
 		//! set the maximal width of a tab. Per default width is 0 which means "no width restriction".
 		virtual void setTabMaxWidth(s32 width ) = 0;
-			
+
 		//! get the maximal width of a tab
 		virtual s32 getTabMaxWidth() const = 0;
-		
+
 		//! Set the alignment of the tabs
 		/** Use EGUIA_UPPERLEFT or EGUIA_LOWERRIGHT */
 		virtual void setTabVerticalAlignment( gui::EGUI_ALIGNMENT alignment ) = 0;

include/IGUIWindow.h

@@ -24,12 +24,15 @@ namespace gui
 			: IGUIElement(EGUIET_WINDOW, environment, parent, id, rectangle) {}
 
 		//! Returns pointer to the close button
+		/** You can hide the button by calling setVisible(false) on the result. */
 		virtual IGUIButton* getCloseButton() const = 0;
 
 		//! Returns pointer to the minimize button
+		/** You can hide the button by calling setVisible(false) on the result. */
 		virtual IGUIButton* getMinimizeButton() const = 0;
 
 		//! Returns pointer to the maximize button
+		/** You can hide the button by calling setVisible(false) on the result. */
 		virtual IGUIButton* getMaximizeButton() const = 0;
 
 		//! Returns true if the window can be dragged with the mouse, false if not