From 5a16a9ccfdbdacb864c5a1f28d46330f74323bc9 Mon Sep 17 00:00:00 2001
From: hybrid <hybrid@dfc29bdd-3216-0410-991c-e03cc46cb475>
Date: Tue, 6 Nov 2007 23:29:59 +0000
Subject: [PATCH] Some code doc updates by Dorth.

git-svn-id: http://svn.code.sf.net/p/irrlicht/code/trunk@1040 dfc29bdd-3216-0410-991c-e03cc46cb475
---
 include/ISceneManager.h                       |  2 +-
 include/SMaterial.h                           | 12 +++----
 source/Irrlicht/BuiltInFont.h                 |  2 +-
 source/Irrlicht/CDefaultGUIElementFactory.cpp |  8 ++---
 source/Irrlicht/CDefaultGUIElementFactory.h   | 36 +++++++++----------
 source/Irrlicht/CGUIButton.cpp                |  8 ++---
 source/Irrlicht/COpenGLMaterialRenderer.h     |  2 +-
 source/Irrlicht/COpenGLNormalMapRenderer.cpp  |  2 +-
 .../Irrlicht/COpenGLParallaxMapRenderer.cpp   |  4 +--
 .../COpenGLShaderMaterialRenderer.cpp         |  2 +-
 10 files changed, 39 insertions(+), 39 deletions(-)

diff --git a/include/ISceneManager.h b/include/ISceneManager.h
index 6da82440..f64ae5c2 100644
--- a/include/ISceneManager.h
+++ b/include/ISceneManager.h
@@ -64,7 +64,7 @@ namespace scene
 		//! This value will never be returned by ISceneManager::getSceneNodeRenderPass().
 		//! The scene manager will determine by itself if an object is
 		//! transparent or solid and register the object as SNRT_TRANSPARENT or
-		//! SNRT_SOLD automaticly if you call registerNodeForRendering with this
+		//! SNRT_SOLD automatically if you call registerNodeForRendering with this
 		//! value (which is default). Note that it will register the node only as ONE type.
 		//! If your scene node has both solid and transparent material types register
 		//! it twice (one time as SNRT_SOLID, the other time as SNRT_TRANSPARENT) and
diff --git a/include/SMaterial.h b/include/SMaterial.h
index d1034797..ac3e1cc7 100644
--- a/include/SMaterial.h
+++ b/include/SMaterial.h
@@ -35,7 +35,7 @@ namespace video
 		EBF_SRC_ALPHA_SATURATE		// src		(min(srcA, 1-destA), idem, ...)
 	};
 
-	//! MaterialTypeParam: eg. DirectX: D3DTOP_MODULATE, D3DTOP_MODULATE2X, D3DTOP_MODULATE4X
+	//! MaterialTypeParam: e.g. DirectX: D3DTOP_MODULATE, D3DTOP_MODULATE2X, D3DTOP_MODULATE4X
 	enum E_MODULATE_FUNC
 	{
 		EMFN_MODULATE_1X	= 1,
@@ -166,12 +166,12 @@ namespace video
 		\endcode */
 		f32 Shininess;
 
-		//! Free parameter dependend on the material type.
+		//! Free parameter, dependent on the material type.
 		/** Mostly ignored, used for example in EMT_PARALLAX_MAP_SOLID
 		and EMT_TRANSPARENT_ALPHA_CHANNEL. */
 		f32 MaterialTypeParam;
 
-		//! Second free parameter dependend on the material type.
+		//! Second free parameter, dependent on the material type.
 		/** Mostly ignored. */
 		f32 MaterialTypeParam2;
 
@@ -197,16 +197,16 @@ namespace video
 		bool Lighting;
 
 		//! Is the ZBuffer enabled? Default: true
-		//! Changed from Bool to Integer
+		//! Changed from bool to integer
 		// ( 0 == ZBuffer Off, 1 == ZBuffer LessEqual, 2 == ZBuffer Equal )
 		u32 ZBuffer;
 
-		//! May be written to the zbuffer or is it readonly.
+		//! Is the zbuffer writeable or is it read-only.
 		/** Default: 1 This flag is ignored, if the MaterialType
 		is a transparent type. */
 		bool ZWriteEnable;
 
-		//! Is backfaceculling enabled? Default: true
+		//! Is backface culling enabled? Default: true
 		bool BackfaceCulling;
 
 		//! Is fog enabled? Default: false
diff --git a/source/Irrlicht/BuiltInFont.h b/source/Irrlicht/BuiltInFont.h
index f2793f1a..bc0a4c25 100644
--- a/source/Irrlicht/BuiltInFont.h
+++ b/source/Irrlicht/BuiltInFont.h
@@ -8,7 +8,7 @@
 #include "IrrCompileConfig.h"
 #ifdef _IRR_COMPILE_WITH_GUI_
 
-// headerfile generated by Bin2H, copyright 2002 by N.Gebhardt.
+// header file generated by Bin2H, copyright 2002 by N.Gebhardt.
 // Bin2H is Freeware. Download it freely from www.code3d.com.
 // for the source bitmap, see builtInFont.bmp
 
diff --git a/source/Irrlicht/CDefaultGUIElementFactory.cpp b/source/Irrlicht/CDefaultGUIElementFactory.cpp
index 8447505a..534c77a0 100644
--- a/source/Irrlicht/CDefaultGUIElementFactory.cpp
+++ b/source/Irrlicht/CDefaultGUIElementFactory.cpp
@@ -99,14 +99,14 @@ IGUIElement* CDefaultGUIElementFactory::addGUIElement(const c8* typeName, IGUIEl
 }
 
 
-//! returns amount of element types this factory is able to create
+//! Returns the amount of element types this factory is able to create.
 s32 CDefaultGUIElementFactory::getCreatableGUIElementTypeCount() const
 {
 	return EGUIET_COUNT;
 }
 
 
-//! returns type of a createable element type
+//! Returns the type of a createable element type.
 EGUI_ELEMENT_TYPE CDefaultGUIElementFactory::getCreateableGUIElementType(s32 idx) const
 {
 	if (idx>=0 && idx<EGUIET_COUNT)
@@ -116,7 +116,7 @@ EGUI_ELEMENT_TYPE CDefaultGUIElementFactory::getCreateableGUIElementType(s32 idx
 }
 
 
-//! returns type name of a createable element type 
+//! Returns the type name of a createable element type.
 const c8* CDefaultGUIElementFactory::getCreateableGUIElementTypeName(s32 idx) const
 {
 	if (idx>=0 && idx<EGUIET_COUNT)
@@ -126,7 +126,7 @@ const c8* CDefaultGUIElementFactory::getCreateableGUIElementTypeName(s32 idx) co
 }
 
 
-//! returns type name of a createable element type 
+//! Returns the type name of a createable element type.
 const c8* CDefaultGUIElementFactory::getCreateableGUIElementTypeName(EGUI_ELEMENT_TYPE type) const
 {
 	// for this factory, type == index
diff --git a/source/Irrlicht/CDefaultGUIElementFactory.h b/source/Irrlicht/CDefaultGUIElementFactory.h
index a8aec20a..860561a8 100644
--- a/source/Irrlicht/CDefaultGUIElementFactory.h
+++ b/source/Irrlicht/CDefaultGUIElementFactory.h
@@ -17,41 +17,41 @@ namespace gui
 	class IGUIElement;
 	class IGUIEnvironment;
 	
-	//!	Interface making it possible to dynamicly create gui elements
+	//! This interface makes it possible to dynamically create gui elements.
 	class CDefaultGUIElementFactory : public IGUIElementFactory
 	{
 	public:
 
 		CDefaultGUIElementFactory(IGUIEnvironment* env);
 
-		//! adds an element to the gui environment based on its type id
+		//! Adds an element to the gui environment based on its type id.
 		/** \param type: Type of the element to add.
-		\param parent: Parent scene node of the new element, can be null to add to the root.
-		\return Returns pointer to the new element or null if not successful. */
+		\param parent: Parent scene node of the new element. A value of 0 adds it to the root.
+		\return Returns pointer to the new element or 0 if unsuccessful. */
 		virtual IGUIElement* addGUIElement(EGUI_ELEMENT_TYPE type, IGUIElement* parent=0);
 
-		//! adds a GUI element to the GUI Environment based on its type name
-		/** \param typeName: Type name of the element to add.
-		\param parent: Parent scene node of the new element, can be null to add it to the root.
-		\return Returns pointer to the new element or null if not successful. */
+		//! Adds a GUI element to the GUI Environment based on its type name.
+		/** \param typeName: Type name of the element to add. Taken from the GUIElementTypeNames c8* array.
+		\param parent: Parent scene node of the new element. A value of 0 adds it to the root.
+		\return Returns pointer to the new element or 0 if unsuccessful. */
 		virtual IGUIElement* addGUIElement(const c8* typeName, IGUIElement* parent=0);
 
-		//! returns amount of GUI element types this factory is able to create
+		//! Returns the amount of GUI element types this factory is able to create.
 		virtual s32 getCreatableGUIElementTypeCount() const;
 
-		//! returns type of a createable element type
-		/** \param idx: Index of the element type in this factory. Must be a value between 0 and
-		getCreatableGUIElementTypeCount() */
+		//! Returns the type of a createable GUI element type based on the index.
+		/** \param idx: Index of the element type in this factory. The value must be equal or greater than 0
+		and lower than getCreatableGUIElementTypeCount(). */
 		virtual EGUI_ELEMENT_TYPE getCreateableGUIElementType(s32 idx) const;
 
-		//! returns type name of a createable GUI element type by index
-		/** \param idx: Index of the type in this factory. Must be a value between 0 and
-		getCreatableGUIElementTypeCount() */
+		//! Returns the type name of a createable GUI element type based on the index.
+		/** \param idx: Index of the element type in this factory. The value must be equal or greater than 0
+		and lower than getCreatableGUIElementTypeCount(). */
 		virtual const c8* getCreateableGUIElementTypeName(s32 idx) const;
 
-		//! returns type name of a createable GUI element
-		/** \param type: Type of GUE element. 
-		\return: Returns name of the type if this factory can create the type, otherwise 0. */
+		//! Returns the type name of a createable GUI element based on its type.
+		/** \param type: Type of the GUI element.
+		\return: Returns the name of the type if this factory can create it, otherwise it returns 0. */
 		virtual const c8* getCreateableGUIElementTypeName(EGUI_ELEMENT_TYPE type) const;
 
 	private:
diff --git a/source/Irrlicht/CGUIButton.cpp b/source/Irrlicht/CGUIButton.cpp
index e0bbea5f..21ca02e3 100644
--- a/source/Irrlicht/CGUIButton.cpp
+++ b/source/Irrlicht/CGUIButton.cpp
@@ -29,11 +29,11 @@ CGUIButton::CGUIButton(IGUIEnvironment* environment, IGUIElement* parent,
 	#endif
 	setNotClipped(noclip);
 
-	// reset sprites
+	// Initialize the sprites.
 	for (u32 i=0; i<EGBS_COUNT; ++i)
 		ButtonSprites[i].Index = -1;
 
-	// this element can be tabbed to
+	// This element can be tabbed.
 	setTabStop(true);
 	setTabOrder(-1);
 }
@@ -318,7 +318,7 @@ void CGUIButton::setImage(video::ITexture* image)
 		setPressedImage(Image);
 }
 
-//! Sets an image which should be displayed on the button when it is in normal state. 
+//! Sets the image which should be displayed on the button when it is in its normal state.
 void CGUIButton::setImage(video::ITexture* image, const core::rect<s32>& pos)
 {
 	if (Image)
@@ -348,7 +348,7 @@ void CGUIButton::setPressedImage(video::ITexture* image)
 		PressedImage->grab();
 }
 
-//! Sets an image which should be displayed on the button when it is in pressed state. 
+//! Sets the image which should be displayed on the button when it is in its pressed state.
 void CGUIButton::setPressedImage(video::ITexture* image, const core::rect<s32>& pos)
 {
 	if (PressedImage)
diff --git a/source/Irrlicht/COpenGLMaterialRenderer.h b/source/Irrlicht/COpenGLMaterialRenderer.h
index 6a82a72d..3b6b911f 100644
--- a/source/Irrlicht/COpenGLMaterialRenderer.h
+++ b/source/Irrlicht/COpenGLMaterialRenderer.h
@@ -479,7 +479,7 @@ public:
 
 			if (Driver->queryFeature(EVDF_MULTITEXTURE))
 			{
-				// detailmap
+				// detail map
 
 				Driver->extGlActiveTexture(GL_TEXTURE1_ARB);
 
diff --git a/source/Irrlicht/COpenGLNormalMapRenderer.cpp b/source/Irrlicht/COpenGLNormalMapRenderer.cpp
index 6f3220fd..0f3d01db 100644
--- a/source/Irrlicht/COpenGLNormalMapRenderer.cpp
+++ b/source/Irrlicht/COpenGLNormalMapRenderer.cpp
@@ -260,7 +260,7 @@ void COpenGLNormalMapRenderer::OnSetConstants(IMaterialRendererServices* service
 	core::matrix4 tr(worldViewProj.getTransposed());
 	services->setVertexShaderConstant(tr.pointer(), 8, 4);
 
-	// here we've got to fetch the fixed function lights from the driver
+	// here we fetch the fixed function lights from the driver
 	// and set them as constants
 
 	u32 cnt = driver->getDynamicLightCount();
diff --git a/source/Irrlicht/COpenGLParallaxMapRenderer.cpp b/source/Irrlicht/COpenGLParallaxMapRenderer.cpp
index a63e401c..28538356 100644
--- a/source/Irrlicht/COpenGLParallaxMapRenderer.cpp
+++ b/source/Irrlicht/COpenGLParallaxMapRenderer.cpp
@@ -216,7 +216,7 @@ COpenGLParallaxMapRenderer::COpenGLParallaxMapRenderer(video::COpenGLDriver* dri
 
 	CallBack = this;
 
-	// basicly, this thing simply compiles these hardcoded shaders if the
+	// basically, this simply compiles the hard coded shaders if the
 	// hardware is able to do them, otherwise it maps to the base material
 
 	if (!driver->queryFeature(video::EVDF_ARB_FRAGMENT_PROGRAM_1) ||
@@ -317,7 +317,7 @@ void COpenGLParallaxMapRenderer::OnSetConstants(IMaterialRendererServices* servi
 	core::matrix4 tr(worldViewProj.getTransposed());
 	services->setVertexShaderConstant(tr.pointer(), 8, 4);
 
-	// here we've got to fetch the fixed function lights from the driver
+	// here we fetch the fixed function lights from the driver
 	// and set them as constants
 
 	u32 cnt = driver->getDynamicLightCount();
diff --git a/source/Irrlicht/COpenGLShaderMaterialRenderer.cpp b/source/Irrlicht/COpenGLShaderMaterialRenderer.cpp
index 0005f633..69a7aca0 100644
--- a/source/Irrlicht/COpenGLShaderMaterialRenderer.cpp
+++ b/source/Irrlicht/COpenGLShaderMaterialRenderer.cpp
@@ -80,7 +80,7 @@ void COpenGLShaderMaterialRenderer::init(s32& outMaterialTypeNr, const c8* verte
 	if (!createPixelShader(pixelShaderProgram))
 		return;
 
-	// register myself as new material
+	// register as a new material
 	outMaterialTypeNr = Driver->addMaterialRenderer(this);
 }