diff --git a/include/niflib.h b/include/niflib.h index 177c52bdfc8d8add8ff699b901729048b9008fdd..4520af407f2e3a29c5ce085dda1841c95b9b6780 100644 --- a/include/niflib.h +++ b/include/niflib.h @@ -160,7 +160,7 @@ NIFLIB_API void WriteNifTree( ostream & in, NiObject * root, const NifInfo & inf /*! * Writes a bunch of files given a base file name, and a pointer to the root object of the Nif file tree. * \param[in] file_name The desired file name for the base NIF file. This name serves as the basis for the names of any Kf files and Kfm files as well. The path is relative to the working directory unless a full path is specified. - * \param[in] root The root object to start from when writing out the NIF file. + * \param[in] root_object The root object to start from when writing out the NIF file. * \param[in] info A NifInfo structure that contains information such as the version of the NIF file to create. * \param[in] export_files What files to write: NIF, NIF + KF + KFM, NIF + KF's + KFM, KF only, KF's only * \param[in] kf_type The KF type (Morrowind style, DAoC style, CivIV style, ...) @@ -208,7 +208,7 @@ NIFLIB_API Ref<NiNode> FindCommonAncestor( const vector< Ref<NiAVObject> > & obj /*! * Returns a list of all the ancestors of a given NiAVObject - * \param leaf[in] The NiAVObject to list the ancestors of. + * \param[in] leaf The NiAVObject to list the ancestors of. * \return A list containing all the ancestors of the given NiAVObject */ NIFLIB_API list< Ref<NiNode> > ListAncestors( NiAVObject * leaf ); @@ -258,7 +258,7 @@ While it is possible to use the pre-compiled DLL file if you are using Microsoft If you need help to do this, there is information about it on our main website here: <a href="http://www.niftools.org/wiki/index.php/Niflib/Compile">Compiling Niflib</a>. -\section include Including the Library +\section include_lib Including the Library Visual Studio 2005 is the preferred compiler for Niflib as this is the platform that all development is done on. The instructions in this guide assume that you are using this compiler. If you do not have a copy, you can <a href="http://msdn.microsoft.com/vstudio/express/downloads/default.aspx">download Microsoft Visual C++ 2005 Express</a> for free from Microsoft. Niflib should work on other compilers, and is tested on GCC from time to time, but you will have to figure out how to use those compilers on your own. @@ -270,24 +270,34 @@ Dynamic linking means that your program will include a Niflib DLL file which the These are the project settings that you should change to use each combination of Debug/Release and DLL/Static. This assumes that you've already created a default empty project with Debug and Release configurations, and are altering those with these additional settings. It also assumes that you're using the provided Niflib project file to build Niflib, and have added Niflib's lib and include folders to the proper paths in the Tools > Options screen under Projects and Solutions > VC++ Directories. -DLL Release: +\subsection dll_release DLL Release: + Configuration Properties > C/C++ > Code Generation = Multi-threaded DLL (/MD) + Configuration Properties > Linker > Additional Dependencies = niflib_dll.lib -DLL Debug: +\subsection dll_debug DLL Debug: + Configuration Properties > C/C++ > Code Generation = Multi-threaded Debug DLL (/MDd) + Configuration Properties > Linker > Additional Dependencies = niflib_dll_debug.lib -Static Release: +\subsection static_release Static Release: + Configuration Properties > C/C++ > Code Generation = Multi-threaded (/MT) -Configuration Properties > Preprocessor > Preprocessor Definitions: (Add this to the end of what is already there, separated by semicolons) NIFLIB_STATIC_LINK + Configuration Properties > Linker > Additional Dependencies = niflib_static.lib -Static Debug: -Configuration Properties > C/C++ > Code Generation = Multi-threaded Debug (/MTd) Configuration Properties > Preprocessor > Preprocessor Definitions: (Add this to the end of what is already there, separated by semicolons) NIFLIB_STATIC_LINK + +\subsection static_debug Static Debug: + +Configuration Properties > C/C++ > Code Generation = Multi-threaded Debug (/MTd) + Configuration Properties > Linker > Additional Dependencies = niflib_static_debug.lib +Configuration Properties > Preprocessor > Preprocessor Definitions: (Add this to the end of what is already there, separated by semicolons) NIFLIB_STATIC_LINK + With that out of the way, you can start writing your source code and include the main Niflib header file: \code @@ -302,7 +312,7 @@ In addition to the main header file, there are also separate headers for each ob You will have one such line in your source code for each NIF object that your program needs access to. -Niflib also wraps all its functions in the "Niflib" namespace. So, depending on your needs, you can either gain access to all Niflib symbols with a using directive that follows the #include statements like this: +Niflib also wraps all its functions in the "Niflib" namespace. So, depending on your needs, you can either gain access to all Niflib symbols with a using directive that follows the include statements like this: \code using namespace Niflib; diff --git a/include/obj/NiAVObject.h b/include/obj/NiAVObject.h index 122f1023427f42daf246e71143cdc1e4b0eb8fdb..f05ce23c911773ddd945ed3de0e674a198e3c36b 100644 --- a/include/obj/NiAVObject.h +++ b/include/obj/NiAVObject.h @@ -143,7 +143,7 @@ public: /*! * Retrieves the property that matches the specified type, if there is one. A valid object should not have more than one property of the same type. Properties specify various charactaristics of the object that affect rendering. They may be shared among objects. - * \param[in] compare-to The type constant of the desired property type. + * \param[in] compare_to The type constant of the desired property type. * \return The property that matches the specified type, or NULL if there isn't a match. * \sa NiObject::TypeConst */ @@ -217,7 +217,7 @@ public: /*! * Sets the current visibility of this object by altering its flag data. - * \param[in] Whether or not the object will now be visible. True if visible, false otherwise. + * \param[in] n Whether or not the object will now be visible. True if visible, false otherwise. */ NIFLIB_API void SetVisibility( bool n ); diff --git a/include/obj/NiLODNode.h b/include/obj/NiLODNode.h index 7eacdf229c3078f4e92638dd38246a34da7e0c87..4de02e217159b5f7ed2051294b92b963865be7a2 100644 --- a/include/obj/NiLODNode.h +++ b/include/obj/NiLODNode.h @@ -97,7 +97,7 @@ public: /*! * Set the data object that refers to LOD level information. - * \param[in] The new LOD level data object or NULL to clear the current one. + * \param[in] value The new LOD level data object or NULL to clear the current one. */ NIFLIB_API void SetLODLevelData( Ref<NiLODData > value ); diff --git a/include/obj/NiNode.h b/include/obj/NiNode.h index 0e2ad06da54e394fc138f51324d500b5494f0e92..5ea1287a8823e2b92b331993a9d3ec5060cc2ee9 100644 --- a/include/obj/NiNode.h +++ b/include/obj/NiNode.h @@ -85,7 +85,7 @@ public: /*! * Retrieves all AV Object children from this node. These are a sub-leafs in the scene graph contained in a NIF file. Each AV Object can only be the child of one node. - * \param[in] A list of all the AV Objects that are children of this node in the scene graph. + * \return A list of all the AV Objects that are children of this node in the scene graph. */ NIFLIB_API vector< Ref<NiAVObject> > GetChildren() const; diff --git a/include/obj/NiTextureEffect.h b/include/obj/NiTextureEffect.h index 304c92aaf764775db380dbeba1c822aea59fa54d..e152207af391dee57cde3dadc5ac66d320b0458a 100644 --- a/include/obj/NiTextureEffect.h +++ b/include/obj/NiTextureEffect.h @@ -191,7 +191,7 @@ public: /*! * Sets a Playstation 2 - specific value. Can just be left at the default of 0. - * \param[in] The new PS2 L value. + * \param[in] value The new PS2 L value. */ NIFLIB_API void SetPs2L( unsigned short value ); @@ -203,7 +203,7 @@ public: /*! * Sets a Playstation 2 - specific value. Can just be left at the default of 0xFFB5. - * \param[in] The new PS2 K value. + * \param[in] value The new PS2 K value. */ NIFLIB_API void SetPs2K( unsigned short value ); diff --git a/include/obj/bhkBoxShape.h b/include/obj/bhkBoxShape.h index 5ab24615d65c136554f0f14b7143f23b1a712e0b..9a7a247473cfcc9d1d67825cf989b14fa65aed85 100644 --- a/include/obj/bhkBoxShape.h +++ b/include/obj/bhkBoxShape.h @@ -65,7 +65,7 @@ public: /*! * Sets the dimentions of the box. - * \param The new dimentions for the bounding box. + * \param value The new dimentions for the bounding box. */ NIFLIB_API void SetDimensions( const Vector3 & value ); diff --git a/include/obj/bhkCapsuleShape.h b/include/obj/bhkCapsuleShape.h index 75ccd4c4792eccadc1fca5b9c06d97525145541e..d6dbdb4b4342a174a08752c6ebad8e86853ea90b 100644 --- a/include/obj/bhkCapsuleShape.h +++ b/include/obj/bhkCapsuleShape.h @@ -89,7 +89,7 @@ public: /*! * Sets the second capsule radius. Seems to match the first capsule radius. - * \param value[in] The new second capsule radius. + * \param[in] value The new second capsule radius. */ NIFLIB_API void SetRadius1( float value ); @@ -113,7 +113,7 @@ public: /*! * Sets the third capsule radius. Seems to match the second capsule radius. - * \param value[in] The new third capsule radius. + * \param[in] value The new third capsule radius. */ NIFLIB_API void SetRadius2( float value ); diff --git a/include/obj/bhkNiTriStripsShape.h b/include/obj/bhkNiTriStripsShape.h index 93a5ddc20e85a9f232f0ef0ee0ebd41ebe24c5f4..b0dd385e3fdc9dfdc716a949618c0be9eff9324d 100644 --- a/include/obj/bhkNiTriStripsShape.h +++ b/include/obj/bhkNiTriStripsShape.h @@ -77,9 +77,9 @@ public: /*! * Sets the number of NiTriStripsData objects referenced by this shape. - * \param[in] n The new number of NiTriStripsData objects. + * \param[in] i The new number of NiTriStripsData objects. */ - NIFLIB_API void SetNumStripsData(int i); + NIFLIB_API void SetNumStripsData( int i ); /*! * Sets the NiTriStripsData object referenced by this shape at the specified index. diff --git a/include/obj/bhkWorldObject.h b/include/obj/bhkWorldObject.h index 54b7383bd03bd2273d38b0fd8dab589b9d678b27..cfdfe31e43094b63ab106b334d038231ed3f9ebb 100644 --- a/include/obj/bhkWorldObject.h +++ b/include/obj/bhkWorldObject.h @@ -64,7 +64,7 @@ public: /*! * Retrieves the shape object that this body is using. - * \param[in] value The shape object being used by this body. + * \return The shape object being used by this body. */ NIFLIB_API Ref<bhkShape > GetShape() const;