Changed documentation style to match that used by KDE/Kate (for Doxygen syntax highlighting)

library/PolyVoxCore/include/PolyVoxCore/Vector.h

@@ -36,36 +36,36 @@ freely, subject to the following restrictions:
 namespace PolyVox
 {
 	/**
-	Represents a vector in space.
+	 * Represents a vector in space.
-	
+	 * 
-	This Vector class is templated on both size and data type. It is designed to be
+	 * This Vector class is templated on both size and data type. It is designed to be
-	generic but so far had only been tested with vectors of size 2 and 3. Also note
+	 * generic but so far had only been tested with vectors of size 2 and 3. Also note
-	that some of the operations do not make sense with integer types, for example it
+	 * that some of the operations do not make sense with integer types, for example it
-	does not make conceptual sense to try and normalise an integer Vector.
+	 * does not make conceptual sense to try and normalise an integer Vector.
-
+	 * 
-	The elements of the Vector are accessed via the overloaded () operator which takes
+	 * The elements of the Vector are accessed via the overloaded () operator which takes
-	an index indicating the element to fetch. They are set using the set() function which
+	 * an index indicating the element to fetch. They are set using the set() function which
-	takes an index indicating the element to set and a new value for that element. For
+	 * takes an index indicating the element to set and a new value for that element. For
-	convienience, the functions getX(), setX(), getY(), setY(), getZ(), setZ(), getw() and setW() 
+	 * convienience, the functions getX(), setX(), getY(), setY(), getZ(), setZ(), getw() and setW() 
-	do the same thing for the first 4 elements of the Vector. 
+	 * do the same thing for the first 4 elements of the Vector. 
-
+	 * 
-	A variety of overloaded operators are also provided for comparison and arithmetic
+	 * A variety of overloaded operators are also provided for comparison and arithmetic
-	operations. For most of these arithmetic operators only the unary versions are 
+	 * operations. For most of these arithmetic operators only the unary versions are 
-	documented below - however often binary versions are also generated by std::operators.
+	 * documented below - however often binary versions are also generated by std::operators.
-
+	 * 
-	Lastly, note that for convienience a set of typedefs are included for 2 and 3 dimensional
+	 * Lastly, note that for convienience a set of typedefs are included for 2 and 3 dimensional
-	vectors with type float, double, int32_t, and uint32_t. They are used as follows:
+	 * vectors with type float, double, int32_t, and uint32_t. They are used as follows:
-
+	 * 
-	\code
+	 * \code
-	Vector2DInt4 test(1,2); //Declares a 2 dimensional Vector of type int4.
+	 * Vector2DInt4 test(1,2); //Declares a 2 dimensional Vector of type int4.
-	\endcode
+	 * \endcode
-
+	 * 
-	Extra things to mention when I when I fill this out shortly:
+	 * Extra things to mention when I when I fill this out shortly:
-		Vector must have at least two elements.
+	 * 	Vector must have at least two elements.
-		Use of 'OperationType'
+	 * 	Use of 'OperationType'
-		Floating point return values are always single precision
+	 * 	Floating point return values are always single precision
-		Component order is WYZW
+	 * 	Component order is WYZW
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	class Vector
     {

library/PolyVoxCore/include/PolyVoxCore/Vector.inl

@@ -25,17 +25,17 @@ namespace PolyVox
 {
     //-------------------------- Constructors, etc ---------------------------------
 	/**
-	Creates a Vector object but does not initialise it.
+	 * Creates a Vector object but does not initialise it.
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	Vector<Size, StorageType, OperationType>::Vector(void)
 	{
 	}
 
 	/**
-    Creates a Vector object and initialises all components with the given value.
+     * Creates a Vector object and initialises all components with the given value.
-    \param tFillValue The value to write to every component.
+     * \param tFillValue The value to write to every component.
-    */
+     */
     template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType>::Vector(StorageType tFillValue)
     {
@@ -46,10 +46,10 @@ namespace PolyVox
     }
 
     /**
-    Creates a Vector object and initialises it with given values.
+     * Creates a Vector object and initialises it with given values.
-    \param x The X component to set.
+     * \param x The X component to set.
-    \param y The Y component to set.
+     * \param y The Y component to set.
-    */
+     */
     template <uint32_t Size,typename StorageType, typename OperationType>
     Vector<Size,StorageType,OperationType>::Vector(StorageType x, StorageType y)
     {
@@ -62,11 +62,11 @@ namespace PolyVox
     }
 
 	/**
-	Creates a Vector3D object and initialises it with given values.
+	 * Creates a Vector3D object and initialises it with given values.
-	\param x The X component to set.
+	 * \param x The X component to set.
-	\param y The Y component to set.
+	 * \param y The Y component to set.
-	\param z the Z component to set.
+	 * \param z the Z component to set.
-	*/
+	 */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType>::Vector(StorageType x, StorageType y, StorageType z)
 	{
@@ -81,12 +81,12 @@ namespace PolyVox
 	}
 
 	/**
-	Creates a Vector3D object and initialises it with given values.
+	 * Creates a Vector3D object and initialises it with given values.
-	\param x The X component to set.
+	 * \param x The X component to set.
-	\param y The Y component to set.
+	 * \param y The Y component to set.
-	\param z The Z component to set.
+	 * \param z The Z component to set.
-	\param w The W component to set.
+	 * \param w The W component to set.
-	*/
+	 */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType>::Vector(StorageType x, StorageType y, StorageType z, StorageType w)
 	{
@@ -101,9 +101,9 @@ namespace PolyVox
 	}
 
     /**
-    Copy constructor builds object based on object passed as parameter.
+     * Copy constructor builds object based on object passed as parameter.
-    \param vector A reference to the Vector to be copied.
+     * \param vector A reference to the Vector to be copied.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	Vector<Size, StorageType, OperationType>::Vector(const Vector<Size, StorageType, OperationType>& vector)
     {
@@ -111,14 +111,14 @@ namespace PolyVox
     }
 
 	/**
-	This copy constructor allows casting between vectors with different data types.
+	 * This copy constructor allows casting between vectors with different data types.
-	It makes it possible to use code such as:
+	 * It makes it possible to use code such as:
-	
+	 * 
-	Vector3DDouble v3dDouble(1.0,2.0,3.0);
+	 * Vector3DDouble v3dDouble(1.0,2.0,3.0);
-	Vector3DFloat v3dFloat = static_cast<Vector3DFloat>(v3dDouble); //Casting
+	 * Vector3DFloat v3dFloat = static_cast<Vector3DFloat>(v3dDouble); //Casting
-
+	 * 
-	\param vector A reference to the Vector to be copied.
+	 * \param vector A reference to the Vector to be copied.
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	template <typename CastType>
 		Vector<Size, StorageType, OperationType>::Vector(const Vector<Size, CastType>& vector)
@@ -130,8 +130,8 @@ namespace PolyVox
 	}
 
     /**
-    Destroys the Vector.
+     * Destroys the Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	Vector<Size, StorageType, OperationType>::~Vector(void)
     {
@@ -146,10 +146,10 @@ namespace PolyVox
     }
 
     /**
-    Assignment operator copies each element of first Vector to the second.
+     * Assignment operator copies each element of first Vector to the second.
-    \param rhs Vector to assign to.
+     * \param rhs Vector to assign to.
-    \return A reference to the result to allow chaining.
+     * \return A reference to the result to allow chaining.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator=(const Vector<Size, StorageType, OperationType>& rhs)
     {
@@ -162,11 +162,11 @@ namespace PolyVox
     }
 
     /**
-    Checks whether two Vectors are equal.
+     * Checks whether two Vectors are equal.
-    \param rhs The Vector to compare to.
+     * \param rhs The Vector to compare to.
-    \return true if the Vectors match.
+     * \return true if the Vectors match.
-    \see operator!=
+     * \see operator!=
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline bool Vector<Size, StorageType, OperationType>::operator==(const Vector<Size, StorageType, OperationType> &rhs) const
     {
@@ -183,11 +183,11 @@ namespace PolyVox
     }
 
 	/**
-    Checks whether two Vectors are not equal.
+     * Checks whether two Vectors are not equal.
-    \param rhs The Vector to compare to.
+     * \param rhs The Vector to compare to.
-    \return true if the Vectors do not match.
+     * \return true if the Vectors do not match.
-    \see operator==
+     * \see operator==
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline bool Vector<Size, StorageType, OperationType>::operator!=(const Vector<Size, StorageType, OperationType> &rhs) const
     {
@@ -195,14 +195,14 @@ namespace PolyVox
     }
 
 	/**
-    Checks whether this vector is less than the parameter. The metric is
+     * Checks whether this vector is less than the parameter. The metric is
-	meaningless but it allows Vectors to me used as key in sdt::map, etc.
+	 * meaningless but it allows Vectors to me used as key in sdt::map, etc.
-	This function is deprecated. You should specify a seperate comparator to the std:map if you need one.
+	 * This function is deprecated. You should specify a seperate comparator to the std:map if you need one.
-    \param rhs The Vector to compare to.
+     * \param rhs The Vector to compare to.
-    \return true if this is less than the parameter
+     * \return true if this is less than the parameter
-    \see operator!=
+     * \see operator!=
-	\deprecated
+	 * \deprecated
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline bool Vector<Size, StorageType, OperationType>::operator<(const Vector<Size, StorageType, OperationType> &rhs) const
     {
@@ -217,10 +217,10 @@ namespace PolyVox
     }    
 
     /**
-    Addition operator adds corresponding elements of the two Vectors.
+     * Addition operator adds corresponding elements of the two Vectors.
-    \param rhs The Vector to add
+     * \param rhs The Vector to add
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator+=(const Vector<Size, StorageType, OperationType>& rhs)
     {
@@ -232,10 +232,10 @@ namespace PolyVox
     }
 
 	/**
-    Subtraction operator subtracts corresponding elements of one Vector from the other.
+     * Subtraction operator subtracts corresponding elements of one Vector from the other.
-    \param rhs The Vector to subtract
+     * \param rhs The Vector to subtract
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator-=(const Vector<Size, StorageType, OperationType>& rhs)
     {
@@ -247,10 +247,10 @@ namespace PolyVox
     }
 
 	/**
-    Multiplication operator multiplies corresponding elements of the two Vectors.
+     * Multiplication operator multiplies corresponding elements of the two Vectors.
-    \param rhs The Vector to multiply by
+     * \param rhs The Vector to multiply by
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator*=(const Vector<Size, StorageType, OperationType>& rhs)
     {
@@ -262,10 +262,10 @@ namespace PolyVox
     }
 
 	/**
-    Division operator divides corresponding elements of one Vector by the other.
+     * Division operator divides corresponding elements of one Vector by the other.
-    \param rhs The Vector to divide by
+     * \param rhs The Vector to divide by
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator/=(const Vector<Size, StorageType, OperationType>& rhs)
     {
@@ -277,10 +277,10 @@ namespace PolyVox
     }
 
     /**
-    Multiplication operator multiplies each element of the Vector by a number.
+     * Multiplication operator multiplies each element of the Vector by a number.
-    \param rhs The number the Vector is multiplied by.
+     * \param rhs The number the Vector is multiplied by.
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator*=(const StorageType& rhs)
     {
@@ -292,10 +292,10 @@ namespace PolyVox
     }
 
     /**
-	Division operator divides each element of the Vector by a number.
+	 * Division operator divides each element of the Vector by a number.
-	\param rhs The number the Vector is divided by.
+	 * \param rhs The number the Vector is divided by.
-	\return The resulting Vector.
+	 * \return The resulting Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType>& Vector<Size, StorageType, OperationType>::operator/=(const StorageType& rhs)
     {
@@ -307,11 +307,11 @@ namespace PolyVox
     }
 
 	/**
-    Addition operator adds corresponding elements of the two Vectors.
+     * Addition operator adds corresponding elements of the two Vectors.
-	\param lhs The Vector to add to.
+	 * \param lhs The Vector to add to.
-    \param rhs The Vector to add.
+     * \param rhs The Vector to add.
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType> operator+(const Vector<Size,StorageType,OperationType>& lhs, const Vector<Size,StorageType,OperationType>& rhs)
 	{
@@ -321,11 +321,11 @@ namespace PolyVox
 	}
 
 	/**
-    Subtraction operator subtracts corresponding elements of one Vector from the other.
+     * Subtraction operator subtracts corresponding elements of one Vector from the other.
-	\param lhs The Vector to subtract from.
+	 * \param lhs The Vector to subtract from.
-    \param rhs The Vector to subtract.
+     * \param rhs The Vector to subtract.
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType> operator-(const Vector<Size,StorageType,OperationType>& lhs, const Vector<Size,StorageType,OperationType>& rhs)
 	{
@@ -335,11 +335,11 @@ namespace PolyVox
 	}
 
 	/**
-    Multiplication operator mulitplies corresponding elements of the two Vectors.
+     * Multiplication operator mulitplies corresponding elements of the two Vectors.
-	\param lhs The Vector to multiply.
+	 * \param lhs The Vector to multiply.
-    \param rhs The Vector to multiply by.
+     * \param rhs The Vector to multiply by.
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType> operator*(const Vector<Size,StorageType,OperationType>& lhs, const Vector<Size,StorageType,OperationType>& rhs)
 	{
@@ -349,11 +349,11 @@ namespace PolyVox
 	}
 
 	/**
-    Division operator divides corresponding elements of one Vector by the other.
+     * Division operator divides corresponding elements of one Vector by the other.
-	\param lhs The Vector to divide.
+	 * \param lhs The Vector to divide.
-    \param rhs The Vector to divide by.
+     * \param rhs The Vector to divide by.
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType> operator/(const Vector<Size,StorageType,OperationType>& lhs, const Vector<Size,StorageType,OperationType>& rhs)
 	{
@@ -363,11 +363,11 @@ namespace PolyVox
 	}
 
 	/**
-    Multiplication operator multiplies each element of the Vector by a number.
+     * Multiplication operator multiplies each element of the Vector by a number.
-	\param lhs The Vector to multiply.
+	 * \param lhs The Vector to multiply.
-    \param rhs The number the Vector is multiplied by.
+     * \param rhs The number the Vector is multiplied by.
-    \return The resulting Vector.
+     * \return The resulting Vector.
-    */
+     */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType> operator*(const Vector<Size,StorageType,OperationType>& lhs, const StorageType& rhs)
 	{
@@ -377,11 +377,11 @@ namespace PolyVox
 	}
 
 	/**
-	Division operator divides each element of the Vector by a number.
+	 * Division operator divides each element of the Vector by a number.
-	\param lhs The Vector to divide.
+	 * \param lhs The Vector to divide.
-	\param rhs The number the Vector is divided by.
+	 * \param rhs The number the Vector is divided by.
-	\return The resulting Vector.
+	 * \return The resulting Vector.
-    */
+     */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	Vector<Size,StorageType,OperationType> operator/(const Vector<Size,StorageType,OperationType>& lhs, const StorageType& rhs)
 	{
@@ -391,11 +391,11 @@ namespace PolyVox
 	}
 
     /**
-    Enables the Vector to be used intuitively with output streams such as cout.
+     * Enables the Vector to be used intuitively with output streams such as cout.
-    \param os The output stream to write to.
+     * \param os The output stream to write to.
-    \param vector The Vector to write to the stream.
+     * \param vector The Vector to write to the stream.
-    \return A reference to the output stream to allow chaining.
+     * \return A reference to the output stream to allow chaining.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	std::ostream& operator<<(std::ostream& os, const Vector<Size, StorageType, OperationType>& vector)
     {
@@ -413,10 +413,10 @@ namespace PolyVox
     }		
 
 	/**
-	Returns the element at the given position.
+	 * Returns the element at the given position.
-	\param index The index of the element to return.
+	 * \param index The index of the element to return.
-	\return The element.
+	 * \return The element.
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	inline StorageType Vector<Size, StorageType, OperationType>::getElement(uint32_t index) const
 	{
@@ -425,8 +425,8 @@ namespace PolyVox
 	}
 
     /**
-    \return A const reference to the X component of a 1, 2, 3, or 4 dimensional Vector.
+     * \return A const reference to the X component of a 1, 2, 3, or 4 dimensional Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline StorageType Vector<Size, StorageType, OperationType>::getX(void) const
     {
@@ -434,8 +434,8 @@ namespace PolyVox
     }	
 
 	/**
-	\return A const reference to the Y component of a 2, 3, or 4 dimensional Vector.
+	 * \return A const reference to the Y component of a 2, 3, or 4 dimensional Vector.
-	*/
+	 */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline StorageType Vector<Size, StorageType, OperationType>::getY(void) const
     {
@@ -443,8 +443,8 @@ namespace PolyVox
     }	
 
 	/**
-	\return A const reference to the Z component of a 3 or 4 dimensional Vector.
+	 * \return A const reference to the Z component of a 3 or 4 dimensional Vector.
-	*/
+	 */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline StorageType Vector<Size, StorageType, OperationType>::getZ(void) const
     {
@@ -456,8 +456,8 @@ namespace PolyVox
     }	
 
 	/**
-	\return A const reference to the W component of a 4 dimensional Vector.
+	 * \return A const reference to the W component of a 4 dimensional Vector.
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	inline StorageType Vector<Size, StorageType, OperationType>::getW(void) const
 	{
@@ -469,9 +469,9 @@ namespace PolyVox
 	}  
 
 	/**
-	\param index The index of the element to set.
+	 * \param index The index of the element to set.
-	\param tValue The new value for the element.
+	 * \param tValue The new value for the element.
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	inline void Vector<Size, StorageType, OperationType>::setElement(uint32_t index, StorageType tValue)
 	{
@@ -480,10 +480,10 @@ namespace PolyVox
 	}
 
 	/**
-    Sets several elements of a vector at once.
+     * Sets several elements of a vector at once.
-    \param x The X component to set.
+     * \param x The X component to set.
-    \param y The Y component to set.
+     * \param y The Y component to set.
-    */
+     */
     template <uint32_t Size,typename StorageType, typename OperationType>
 	inline void Vector<Size,StorageType,OperationType>::setElements(StorageType x, StorageType y)
     {
@@ -493,11 +493,11 @@ namespace PolyVox
     }
 
 	/**
-	Sets several elements of a vector at once.
+	 * Sets several elements of a vector at once.
-	\param x The X component to set.
+	 * \param x The X component to set.
-	\param y The Y component to set.
+	 * \param y The Y component to set.
-	\param z The Z component to set.
+	 * \param z The Z component to set.
-	*/
+	 */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	inline void Vector<Size,StorageType,OperationType>::setElements(StorageType x, StorageType y, StorageType z)
 	{
@@ -510,12 +510,12 @@ namespace PolyVox
 	}
 
 	/**
-	Sets several elements of a vector at once.
+	 * Sets several elements of a vector at once.
-	\param x The X component to set.
+	 * \param x The X component to set.
-	\param y The Y component to set.
+	 * \param y The Y component to set.
-	\param z The Z component to set.
+	 * \param z The Z component to set.
-	\param w The W component to set.
+	 * \param w The W component to set.
-	*/
+	 */
 	template <uint32_t Size,typename StorageType, typename OperationType>
 	inline void Vector<Size,StorageType,OperationType>::setElements(StorageType x, StorageType y, StorageType z, StorageType w)
 	{
@@ -529,8 +529,8 @@ namespace PolyVox
 	}
 
 	/**
-	\param tX The new value for the X component of a 1, 2, 3, or 4 dimensional Vector.
+	 * \param tX The new value for the X component of a 1, 2, 3, or 4 dimensional Vector.
-	*/
+	 */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline void Vector<Size, StorageType, OperationType>::setX(StorageType tX)
     {
@@ -538,8 +538,8 @@ namespace PolyVox
     }
 
 	/**
-	\param tY The new value for the Y component of a 2, 3, or 4 dimensional Vector.
+	 * \param tY The new value for the Y component of a 2, 3, or 4 dimensional Vector.
-	*/
+	 */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline void Vector<Size, StorageType, OperationType>::setY(StorageType tY)
     {
@@ -547,8 +547,8 @@ namespace PolyVox
     }
 
 	/**
-	\param tZ The new value for the Z component of a 3 or 4 dimensional Vector.
+	 * \param tZ The new value for the Z component of a 3 or 4 dimensional Vector.
-	*/
+	 */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline void Vector<Size, StorageType, OperationType>::setZ(StorageType tZ)
     {
@@ -559,8 +559,8 @@ namespace PolyVox
     }
 
 	/**
-	\param tW The new value for the W component of a 4 dimensional Vector.
+	 * \param tW The new value for the W component of a 4 dimensional Vector.
-	*/
+	 */
 	template <uint32_t Size, typename StorageType, typename OperationType>
 	inline void Vector<Size, StorageType, OperationType>::setW(StorageType tW)
     {
@@ -571,9 +571,9 @@ namespace PolyVox
     }
 
 	/**
-	\note This function always returns a single precision floating point value, even when the StorageType is a double precision floating point value or an integer.
+	 * \note This function always returns a single precision floating point value, even when the StorageType is a double precision floating point value or an integer.
-    \return The length of the Vector.
+     * \return The length of the Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline float Vector<Size, StorageType, OperationType>::length(void) const
     {
@@ -581,8 +581,8 @@ namespace PolyVox
     }
 
     /**
-    \return The squared length of the Vector.
+     * \return The squared length of the Vector.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline OperationType Vector<Size, StorageType, OperationType>::lengthSquared(void) const
     {
@@ -595,14 +595,14 @@ namespace PolyVox
     }
 
     /**
-    This function is commutative, such that a.angleTo(b) == b.angleTo(a). The angle
+     * This function is commutative, such that a.angleTo(b) == b.angleTo(a). The angle
-    returned is in radians and varies between 0 and 3.14(pi). It is always positive.
+     * returned is in radians and varies between 0 and 3.14(pi). It is always positive.
-
+	 * 
-	\note This function always returns a single precision floating point value, even when the StorageType is a double precision floating point value or an integer.
+	 * \note This function always returns a single precision floating point value, even when the StorageType is a double precision floating point value or an integer.
-
+	 * 
-    \param vector The Vector to find the angle to.
+     * \param vector The Vector to find the angle to.
-    \return The angle between them in radians.
+     * \return The angle between them in radians.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline float Vector<Size, StorageType, OperationType>::angleTo(const Vector<Size, StorageType, OperationType>& vector) const
     {
@@ -610,17 +610,17 @@ namespace PolyVox
     }
 
     /**
-    This function is used to calculate the cross product of two Vectors.
+     * This function is used to calculate the cross product of two Vectors.
-    The cross product is the Vector which is perpendicular to the two
+     * The cross product is the Vector which is perpendicular to the two
-    given Vectors. It is worth remembering that, unlike the dot product,
+     * given Vectors. It is worth remembering that, unlike the dot product,
-    it is not commutative. E.g a.b != b.a. The cross product obeys the 
+     * it is not commutative. E.g a.b != b.a. The cross product obeys the 
-	right-hand rule such that if the two vectors are given by the index
+	 * right-hand rule such that if the two vectors are given by the index
-	finger and middle finger respectively then the cross product is given
+	 * finger and middle finger respectively then the cross product is given
-	by the thumb.
+	 * by the thumb.
-    \param vector The vector to cross with this
+     * \param vector The vector to cross with this
-    \return The value of the cross product.
+     * \return The value of the cross product.
-    \see dot()
+     * \see dot()
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline Vector<Size, StorageType, OperationType> Vector<Size, StorageType, OperationType>::cross(const Vector<Size, StorageType, OperationType>& vector) const
     {
@@ -631,12 +631,12 @@ namespace PolyVox
     }
 
     /**
-    Calculates the dot product of the Vector and the parameter.
+     * Calculates the dot product of the Vector and the parameter.
-    This function is commutative, such that a.dot(b) == b.dot(a).
+     * This function is commutative, such that a.dot(b) == b.dot(a).
-    \param rhs The Vector to find the dot product with.
+     * \param rhs The Vector to find the dot product with.
-    \return The value of the dot product.
+     * \return The value of the dot product.
-    \see cross()
+     * \see cross()
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline OperationType Vector<Size, StorageType, OperationType>::dot(const Vector<Size, StorageType, OperationType>& rhs) const
     {
@@ -649,12 +649,12 @@ namespace PolyVox
     }
 
     /**
-    Divides the i, j, and k components by the length to give a Vector of length 1.0. If the vector is
+     * Divides the i, j, and k components by the length to give a Vector of length 1.0. If the vector is
-	very short (or zero) then a divide by zero may cause elements to take on invalid values. You may
+	 * very short (or zero) then a divide by zero may cause elements to take on invalid values. You may
-	want to check for this before normalising.
+	 * want to check for this before normalising.
-
+	 * 
-	\note You should not attempt to normalise a vector whose StorageType is an integer.
+	 * \note You should not attempt to normalise a vector whose StorageType is an integer.
-    */
+     */
     template <uint32_t Size, typename StorageType, typename OperationType>
 	inline void Vector<Size, StorageType, OperationType>::normalise(void)
     {