Rewrote the main documentation pages and fixed some warnings in other documentation.

nif_math.h

@@ -604,7 +604,7 @@ struct Matrix44 {
 	/*! This constructor allows a 4x4 transform matrix to be initalized from a
 	 * translate vector, a 3x3 rotation matrix, and a scale factor.
 	 * \param translate The translation vector that specifies the new x, y, and z coordinates.
-	 * \param rotate The 3x3 rotation matrix.
+	 * \param rotation The 3x3 rotation matrix.
 	 * \param scale The scale factor.
 	 */
 	NIFLIB_API Matrix44( const Vector3 & translate, const Matrix33 & rotation, float scale );
@@ -711,7 +711,7 @@ struct Matrix44 {
 	NIFLIB_API float Determinant() const;
 
 	/*! Calculates the inverse of this matrix.
-	 * \retun The inverse of this matrix.
+	 * \return The inverse of this matrix.
 	 */
 	NIFLIB_API Matrix44 Inverse() const;
 

obj/NiControllerSequence.h

@@ -43,7 +43,7 @@ public:
 
 	/*! Sets the name and block reference to the NiTextKeyExtraData block which will be used by this controller sequence to specify the keyframe labels or "notes."
 	 * \param new_name The name of the NiTextKeyExtraData block to use.
-	 * \param new_link The block reference of the NiTextKeyExtraData block to use.
+	 * \param txt_key A reference to the NiTextKeyExtraData object to use.
 	 * \sa NiTextKeyExtraData
 	 */
 	void SetTextKey( const string new_name, const Ref<NiTextKeyExtraData> & txt_key );

obj/NiMorphData.h

@@ -78,6 +78,7 @@ public:
 	vector< Key<float> > GetMorphKeys( int n ) const;
 
 	/*! Sets the morph key data.
+	 * \param n The index of the morph target to set the keys for.
 	 * \param keys A vector containing new Key<float> data which will replace any existing data for this morph target.
 	 * \sa NiMorphData::GetMorphKeys, Key
 	 */

obj/NiObject.h

@@ -84,7 +84,7 @@ public:
 
 	/*!
 	 * Summarizes the information contained in this block in English.
-	 * \verbose Determines whether or not detailed information about large areas of data will be printed out.
+	 * \param verbose Determines whether or not detailed information about large areas of data will be printed out.
 	 * \return A string containing a summary of the information within the block in English.  This is the function that Niflyze calls to generate its analysis, so the output is the same.
 	 * 
 	 * <b>Example:</b> 

obj/NiPalette.h

@@ -38,7 +38,7 @@ public:
 	vector<Color4> GetPalette() const;
 
 	/*! Sets the palette data for this palette block.
-	 * \param new_apl A vector containing the the new colors to be stored in the palette.
+	 * \param new_pal A vector containing the the new colors to be stored in the palette.
 	 * \sa NiPalette::GetPalette
 	 */
 	void SetPalette( const vector<Color4> & new_pal );

obj/NiTexturingProperty.h

 /* Copyright (c) 2006, NIF File Format Library and Tools
 All rights reserved.  Please see niflib.h for licence. */
 
-#ifndef _NITEXTURINGPROPERTY_H_
-#define _NITEXTURINGPROPERTY_H_
+#ifndef _NNiTexturingProperty_H_
+#define _NNiTexturingProperty_H_
 
 #include "NiProperty.h"
 // Include structures
@@ -11,17 +11,17 @@ All rights reserved.  Please see niflib.h for licence. */
 
 #include "../gen/obj_defines.h"
 
-class NiTexturingProperty;
-typedef Ref<NiTexturingProperty> NiTexturingPropertyRef;
+class NNiTexturingProperty;
+typedef Ref<NNiTexturingProperty> NNiTexturingPropertyRef;
 
 /*!
- * NiTexturingProperty - Describes an object's textures.
+ * NNiTexturingProperty - Describes an object's textures.
  */
 
-class NIFLIB_API NiTexturingProperty : public NI_TEXTURING_PROPERTY_PARENT {
+class NIFLIB_API NNiTexturingProperty : public NI_TEXTURING_PROPERTY_PARENT {
 public:
-	NiTexturingProperty();
-	~NiTexturingProperty();
+	NNiTexturingProperty();
+	~NNiTexturingProperty();
 	//Run-Time Type Information
 	static const Type & TypeConst() { return TYPE; }
 private:	
@@ -36,110 +36,110 @@ public:
 
 	/*! Retrieves the number of texture slots defined by this texturing propery.  Texture slots may or may not actually contain textures, but each slot has a different meaning so the way a texture is used is dependant upon which slot it is in.
 	 * \return The number of texture slots defined by this texturing property.
-	 * \sa ITexturingProperty::SetTextureCount
+	 * \sa NiTexturingProperty::SetTextureCount
 	 */
 	int GetTextureCount() const;
 
 	/*! Sets the number of texture slots defined by this texturing propery.  Known valid values are 7 and 8.
-	 * \param n The new size of the texture slot array.
-	 * \sa ITexturingProperty::GetTextureCount
+	 * \param new_count The new size of the texture slot array.
+	 * \sa NiTexturingProperty::GetTextureCount
 	 */
 	void SetTextureCount( int new_count );
 
 	/*! Retrieves the number of extra texture slots defined by this texturing propery.  These only exist in later Nif versions and their function is unknown.
 	 * \return The number of extra texture slots defined by this texturing property.
-	 * \sa ITexturingProperty::SetExtraTextureCount
+	 * \sa NiTexturingProperty::SetExtraTextureCount
 	 */
 	int GetShaderTextureCount() const;
 
 	/*! Sets the number of extra texture slots defined by this texturing propery.  Often zero.
-	 * \param n The new size of the extra texture slot array.
-	 * \sa ITexturingProperty::GetExtraTextureCount
+	 * \param new_count The new size of the extra texture slot array.
+	 * \sa NiTexturingProperty::GetExtraTextureCount
 	 */
 	void SetShaderTextureCount( int new_count );
 
 	/*! Retrieves the current apply mode for this texturing propery.  This enum value affects the way the textures will be drawn.
 	 * \return The current apply mode for this texturing property.
-	 * \sa ITexturingProperty::SetApplyMode
+	 * \sa NiTexturingProperty::SetApplyMode
 	 */
 	ApplyMode GetApplyMode() const;
 
 	/*! Sets the current apply mode for this texturing propery.  This enum value affects the way the textures will be drawn.
 	 * \param new_val The new apply mode for this texturing property.
-	 * \sa ITexturingProperty::GetApplyMode
+	 * \sa NiTexturingProperty::GetApplyMode
 	 */
 	void SetApplyMode( ApplyMode new_val );
 
 	/*! Retrieves the texture desription structure that describes a texture by slot number.  The TexType enum is provided to make it easy to select the texture slot with the specific qualities that you want.
-	 * \param n The slot number of the texture to get the texture description of.  This is a positive zero based index that must be less than the value returned by ITexturingProperty::GetTextureCount.
-	 * \sa ITexturingProperty::SetTexture, TexType
+	 * \param n The slot number of the texture to get the texture description of.  This is a positive zero based index that must be less than the value returned by NiTexturingProperty::GetTextureCount.
+	 * \sa NiTexturingProperty::SetTexture, TexType
 	 */
 	TexDesc GetTexture( int n ) const;
 
 	/*! Checks whether a particular texture type is being used
-	 * \param n The slot number of the texture to check.  This is a positive zero based index that must be less than the value returned by NiTexturingProperty::GetTextureCount.
+	 * \param n The slot number of the texture to check.  This is a positive zero based index that must be less than the value returned by NNiTexturingProperty::GetTextureCount.
 	 * \return true if the texture in this slot is used, false otherwise.
 	 */
 	bool HasTexture( int n ) const;
 
 	/*! Clears a specific texture slot.
-	 * \param n The slot number of the texture to clear.  This is a positive zero based index that must be less than the value returned by NiTexturingProperty::GetTextureCount.
+	 * \param n The slot number of the texture to clear.  This is a positive zero based index that must be less than the value returned by NNiTexturingProperty::GetTextureCount.
 	 */
 	void ClearTexture( int n );
 
 	/*! Sets a new description for the texture in the given slot number.  The TexType enum is provided to make it easy to select the texture slot with the specific qualities that you want.
-	 * \param n The slot number of the texture to set the texture description of.  This is a positive zero based index that must be less than the value returned by ITexturingProperty::GetTextureCount.
+	 * \param n The slot number of the texture to set the texture description of.  This is a positive zero based index that must be less than the value returned by NiTexturingProperty::GetTextureCount.
 	 * \param new_val Thew new texture descriptoin for the texture at the given slot number.
-	 * \sa ITexturingProperty::GetTexture, TexType
+	 * \sa NiTexturingProperty::GetTexture, TexType
 	 */
 	void SetTexture( int n, TexDesc & new_val );
 
 	/*! Retrieves the texture desription structure that describes an extra texture by slot number.  These only exist in the later Nif versions and their function is unknown.
-	 * \param n The slot number of the extra texture to get the texture description of.  This is a positive zero based index that must be less than the value returned by ITexturingProperty::GetExtraTextureCount.
-	 * \sa ITexturingProperty::SetExtraTexture
+	 * \param n The slot number of the extra texture to get the texture description of.  This is a positive zero based index that must be less than the value returned by NiTexturingProperty::GetExtraTextureCount.
+	 * \sa NiTexturingProperty::SetExtraTexture
 	 */
 	TexDesc GetShaderTexture( int n ) const;
 
 	/*! Sets a new description for the texture in the given slot number.  These only exist in the later Nif versions and their function is unknown.
-	 * \param n The slot number of the extra texture to set the texture description of.  This is a positive zero based index that must be less than the value returned by ITexturingProperty::GetTextureCount.
+	 * \param n The slot number of the extra texture to set the texture description of.  This is a positive zero based index that must be less than the value returned by NiTexturingProperty::GetTextureCount.
 	 * \param new_val Thew new texture descriptoin for the extra texture at the given slot number.
-	 * \sa ITexturingProperty::GetTexture, TexType
+	 * \sa NiTexturingProperty::GetTexture, TexType
 	 */
 	void SetShaderTexture( int n, TexDesc & new_val );
 
 	/*! Retrieves the bump map luma offset.  This is only relevant if a texture is defined in the BUMP_MAP texture slot.  The function of this is unknown.
 	 * \return The bump map luma offset.
-	 * \sa ITexturingProperty::SetLumaOffset
+	 * \sa NiTexturingProperty::SetLumaOffset
 	 */
 	float GetLumaOffset() const;
 
 	/*! Sets the bump map luma offset.  This is only relevant if a texture is defined in the BUMP_MAP texture slot.  The function of this is unknown.
 	 * \param new_val The new bump map luma offset.
-	 * \sa ITexturingProperty::GetLumaOffset
+	 * \sa NiTexturingProperty::GetLumaOffset
 	 */
 	void SetLumaOffset( float new_val );
 
 	/*! Retrieves the bump map luma scale.  This is only relevant if a texture is defined in the BUMP_MAP texture slot.  The function of this is unknown.
 	 * \return The bump map luma scale.
-	 * \sa ITexturingProperty::SetLumaScale
+	 * \sa NiTexturingProperty::SetLumaScale
 	 */
 	float GetLumaScale() const;
 
 	/*! Sets the bump map luma scale.  This is only relevant if a texture is defined in the BUMP_MAP texture slot.  The function of this is unknown.
 	 * \param new_val The new bump map luma scale.
-	 * \sa ITexturingProperty::GetLumaScale
+	 * \sa NiTexturingProperty::GetLumaScale
 	 */
 	void SetLumaScale( float new_val );
 
 	/*! Retrieves the bump map matrix.  This is only relevant if a texture is defined in the BUMP_MAP texture slot.  The function of this is unknown.
 	 * \return the bump map matrix.
-	 * \sa ITexturingProperty::SetBumpMapMatrix
+	 * \sa NiTexturingProperty::SetBumpMapMatrix
 	 */
 	Matrix22 GetBumpMapMatrix() const;
 
 	/*! Sets the bump map matrix.  This is only relevant if a texture is defined in the BUMP_MAP texture slot.  The function of this is unknown.
 	 * \param new_val The new bump map matrix.
-	 * \sa ITexturingProperty::GetBumpMapMatrix
+	 * \sa NiTexturingProperty::GetBumpMapMatrix
 	 */
 	void SetBumpMapMatrix( Matrix22 & new_val );
 

obj/NiTriStripsData.h

@@ -64,6 +64,7 @@ public:
 
 	/*! Used to set the triangle face data in a specific triangle strip.
 	 * \param index The index of the triangle strip to set the face data for.  This is a zero-based index which must be a positive number less than that returned by NiTriStripsData::GetStripCount.
+	 * \param in The vertex indices that make up this strip, in standard OpenGL triangle strip order.
 	 * \sa NiTriStripData::GetStrip, NiTriStripData::GetTriangles
 	 */
 	void SetStrip( int index, const vector<ushort> & in );