Added some doc comments to IVolumeLightSceneNode.h and changed "colour" to...

Added some doc comments to IVolumeLightSceneNode.h and changed "colour" to American English "color" for consistency

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

include/IVolumeLightSceneNode.h

@@ -29,22 +29,32 @@ namespace scene
 		//! Returns type of the scene node
 		virtual ESCENE_NODE_TYPE getType() const { return ESNT_VOLUME_LIGHT; }
 
+		//! Sets the number of segments across the U axis
 		virtual void setSubDivideU(const u32 inU) =0;
+		
+		//! Sets the number of segments across the V axis
 		virtual void setSubDivideV(const u32 inV) =0;
 
+		//! Returns the number of segments across the U axis
 		virtual u32 getSubDivideU() const =0;
+
+		//! Returns the number of segments across the V axis
 		virtual u32 getSubDivideV() const =0;
 
-		virtual void setFootColour(const video::SColor inColour) =0;
-		virtual void setTailColour(const video::SColor inColour) =0;
+		//! Sets the color of the base of the light
+		virtual void setFootColor(const video::SColor inColour) =0;
+
+		//! Sets the color of the tip of the light
+		virtual void setTailColor(const video::SColor inColour) =0;
 
-		virtual video::SColor getFootColour() const =0;
-		virtual video::SColor getTailColour() const =0;
+		//! Returns the color of the base of the light
+		virtual video::SColor getFootColor() const =0;
 
+		//! Returns the color of the tip of the light
+		virtual video::SColor getTailColor() const =0;
 	};
 
 } // end namespace scene
 } // end namespace irr
 
 #endif
-

source/Irrlicht/CVolumeLightSceneNode.cpp

@@ -118,7 +118,7 @@ void CVolumeLightSceneNode::setSubDivideV (const u32 inV)
 }
 
 
-void CVolumeLightSceneNode::setFootColour(const video::SColor inColor)
+void CVolumeLightSceneNode::setFootColor(const video::SColor inColor)
 {
 	if (inColor != FootColor)
 	{
@@ -128,7 +128,7 @@ void CVolumeLightSceneNode::setFootColour(const video::SColor inColor)
 }
 
 
-void CVolumeLightSceneNode::setTailColour(const video::SColor inColor)
+void CVolumeLightSceneNode::setTailColor(const video::SColor inColor)
 {
 	if (inColor != TailColor)
 	{
@@ -147,8 +147,8 @@ void CVolumeLightSceneNode::serializeAttributes(io::IAttributes* out, io::SAttri
 	out->addInt("subDivideU", SubdivideU);
 	out->addInt("subDivideV", SubdivideV);
 
-	out->addColor("footColour", FootColor);
-	out->addColor("tailColour", TailColor);
+	out->addColor("footColor", FootColor);
+	out->addColor("tailColor", TailColor);
 
 	out->addVector3d("lightDimension", LightDimensions);
 }
@@ -166,8 +166,8 @@ void CVolumeLightSceneNode::deserializeAttributes(io::IAttributes* in, io::SAttr
 	SubdivideV = in->getAttributeAsInt("subDivideV");
 	SubdivideV = core::max_(SubdivideV, 1u);
 
-	FootColor = in->getAttributeAsColor("footColour");
-	TailColor = in->getAttributeAsColor("tailColour");
+	FootColor = in->getAttributeAsColor("footColor");
+	TailColor = in->getAttributeAsColor("tailColor");
 
 	LightDimensions = in->getAttributeAsVector3d("lightDimension");
 

source/Irrlicht/CVolumeLightSceneNode.h

@@ -61,11 +61,11 @@ namespace scene
 		virtual u32 getSubDivideU() const { return SubdivideU; }
 		virtual u32 getSubDivideV() const { return SubdivideV; }
 
-		virtual void setFootColour(const video::SColor inColor);
-		virtual void setTailColour(const video::SColor inColor);
+		virtual void setFootColor(const video::SColor inColor);
+		virtual void setTailColor(const video::SColor inColor);
 
-		virtual video::SColor getFootColour() const { return FootColor; }
-		virtual video::SColor getTailColour() const { return TailColor; }
+		virtual video::SColor getFootColor() const { return FootColor; }
+		virtual video::SColor getTailColor() const { return TailColor; }
 
 	private:
 		void constructLight();