Added minimum timelines for removing deprecated methods.

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

include/IBoneSceneNode.h

@@ -60,7 +60,7 @@ namespace scene
 			ISceneNode(parent, mgr, id),positionHint(-1),scaleHint(-1),rotationHint(-1) { }
 
 		//! Get the name of the bone
-		/** \deprecated Use getName instead. */
+		/** \deprecated Use getName instead. This method may be removed by Irrlicht 1.9 */
 		_IRR_DEPRECATED_ virtual const c8* getBoneName() const { return getName(); }
 
 		//! Get the index of the bone

include/IEventReceiver.h

@@ -245,11 +245,12 @@ namespace irr
 			//! A tree view node was expanded. See IGUITreeView::getLastEventNode().
 			EGET_TREEVIEW_NODE_EXPAND,
 
-			//! deprecated - use EGET_TREEVIEW_NODE_COLLAPSE instead
-			EGET_TREEVIEW_NODE_COLLAPS,
-
 			//! A tree view node was collapsed. See IGUITreeView::getLastEventNode().
-			EGET_TREEVIEW_NODE_COLLAPSE = EGET_TREEVIEW_NODE_COLLAPS,
+			EGET_TREEVIEW_NODE_COLLAPSE,
+
+			//! deprecated - use EGET_TREEVIEW_NODE_COLLAPSE instead. This 
+			//! may be removed by Irrlicht 1.9 
+			EGET_TREEVIEW_NODE_COLLAPS = EGET_TREEVIEW_NODE_COLLAPSE,
 
 			//! No real event. Just for convenience to get number of events
 			EGET_COUNT

include/IGUISkin.h

@@ -31,8 +31,10 @@ namespace gui
 	{
 		//! Default windows look and feel
 		EGST_WINDOWS_CLASSIC=0,
+
 		//! Like EGST_WINDOWS_CLASSIC, but with metallic shaded windows and buttons
 		EGST_WINDOWS_METALLIC,
+
 		//! Burning's skin
 		EGST_BURNING_SKIN,
 
@@ -155,9 +157,9 @@ namespace gui
 		EGDS_WINDOW_BUTTON_WIDTH,
 		//! width of a checkbox check
 		EGDS_CHECK_BOX_WIDTH,
-		//! deprecated
+		//! \deprecated This may be removed by Irrlicht 1.9
 		EGDS_MESSAGE_BOX_WIDTH,
-		//! deprecated
+		//! \deprecated This may be removed by Irrlicht 1.9
 		EGDS_MESSAGE_BOX_HEIGHT,
 		//! width of a default button
 		EGDS_BUTTON_WIDTH,
@@ -292,6 +294,7 @@ namespace gui
 		EGDI_MORE_DOWN,
 		//! plus icon for trees
 		EGDI_EXPAND,
+
 		//! minus icon for trees
 		EGDI_COLLAPSE,
 		//! file icon for file selection

include/IGUITreeView.h

@@ -70,7 +70,8 @@ namespace gui
 		virtual void clearChildren() = 0;
 
 		//! removes all children (recursive) from this node
-		/** \deprecated Deprecated in 1.8, use clearChildren() instead. */
+		/** \deprecated Deprecated in 1.8, use clearChildren() instead.
+		This method may be removed by Irrlicht 1.9 */
 		_IRR_DEPRECATED_ void clearChilds()
 		{
 			return clearChildren();
@@ -80,7 +81,8 @@ namespace gui
 		virtual bool hasChildren() const = 0;
 
 		//! returns true if this node has child nodes
-		/** \deprecated Deprecated in 1.8, use hasChildren() instead. */
+		/** \deprecated Deprecated in 1.8, use hasChildren() instead. 
+		This method may be removed by Irrlicht 1.9 */
 		_IRR_DEPRECATED_ bool hasChilds() const
 		{
 			return hasChildren();

include/IMeshCache.h

@@ -79,35 +79,40 @@ namespace scene
 		virtual IAnimatedMesh* getMeshByIndex(u32 index) = 0;
 
 		//! Returns a mesh based on its name (often a filename).
-		/** \deprecated Use getMeshByName() instead. */
+		/** \deprecated Use getMeshByName() instead. This method may be removed by
+		Irrlicht 1.9 */
 		_IRR_DEPRECATED_ IAnimatedMesh* getMeshByFilename(const io::path& filename)
 		{
 			return getMeshByName(filename);
 		}
 
 		//! Get the name of a loaded mesh, based on its index. (Name is often identical to the filename).
-		/** \deprecated Use getMeshName() instead. */
+		/** \deprecated Use getMeshName() instead. This method may be removed by
+		Irrlicht 1.9 */
 		_IRR_DEPRECATED_ const io::path& getMeshFilename(u32 index) const
 		{
 			return getMeshName(index).getInternalName();
 		}
 
 		//! Get the name of a loaded mesh, if there is any. (Name is often identical to the filename).
-		/** \deprecated Use getMeshName() instead. */
+		/** \deprecated Use getMeshName() instead. This method may be removed by
+		Irrlicht 1.9 */
 		_IRR_DEPRECATED_ const io::path& getMeshFilename(const IMesh* const mesh) const
 		{
 			return getMeshName(mesh).getInternalName();
 		}
 
 		//! Renames a loaded mesh.
-		/**	\deprecated Use renameMesh() instead. */
+		/**	\deprecated Use renameMesh() instead. This method may be removed by
+		Irrlicht 1.9 */
 		_IRR_DEPRECATED_ bool setMeshFilename(u32 index, const io::path& filename)
 		{
 			return renameMesh(index, filename);
 		}
 
 		//! Renames a loaded mesh.
-		/** \deprecated Use renameMesh() instead. */
+		/** \deprecated Use renameMesh() instead. This method may be removed by
+		Irrlicht 1.9 */
 		_IRR_DEPRECATED_ bool setMeshFilename(const IMesh* const mesh, const io::path& filename)
 		{
 			return renameMesh(mesh, filename);

include/IMeshManipulator.h

@@ -91,7 +91,7 @@ namespace scene
 		}
 
 		//! Scales the actual mesh, not a scene node.
-		/** \deprecated Use scale() instead
+		/** \deprecated Use scale() instead. This method may be removed by Irrlicht 1.9 
 		\param mesh Mesh on which the operation is performed.
 		\param factor Scale factor for each axis. */
 		_IRR_DEPRECATED_ void scaleMesh(IMesh* mesh, const core::vector3df& factor) const {return scale(mesh,factor);}
@@ -131,7 +131,7 @@ namespace scene
 		}
 
 		//! Applies a transformation to a mesh
-		/** \deprecated Use transform() instead
+		/** \deprecated Use transform() instead. This method may be removed by Irrlicht 1.9 
 		\param mesh Mesh on which the operation is performed.
 		\param m transformation matrix. */
 		_IRR_DEPRECATED_ virtual void transformMesh(IMesh* mesh, const core::matrix4& m) const {return transform(mesh,m);}

include/ISceneManager.h

@@ -565,7 +565,7 @@ namespace scene
 			s32 id=-1, s32 minimalPolysPerNode=512, bool alsoAddIfMeshPointerZero=false) = 0;
 
 		//! Adds a scene node for rendering using a octree to the scene graph.
-		/** \deprecated Use addOctreeSceneNode instead. */
+		/** \deprecated Use addOctreeSceneNode instead. This method may be removed by Irrlicht 1.9. */
 		_IRR_DEPRECATED_ IMeshSceneNode* addOctTreeSceneNode(IAnimatedMesh* mesh, ISceneNode* parent=0,
 			s32 id=-1, s32 minimalPolysPerNode=512, bool alsoAddIfMeshPointerZero=false)
 		{
@@ -589,7 +589,7 @@ namespace scene
 			s32 id=-1, s32 minimalPolysPerNode=256, bool alsoAddIfMeshPointerZero=false) = 0;
 
 		//! Adds a scene node for rendering using a octree to the scene graph.
-		/** \deprecated Use addOctreeSceneNode instead. */
+		/** \deprecated Use addOctreeSceneNode instead. This method may be removed by Irrlicht 1.9. */
 		_IRR_DEPRECATED_ IMeshSceneNode* addOctTreeSceneNode(IMesh* mesh, ISceneNode* parent=0,
 			s32 id=-1, s32 minimalPolysPerNode=256, bool alsoAddIfMeshPointerZero=false)
 		{
@@ -1333,7 +1333,7 @@ namespace scene
 			ISceneNode* node, s32 minimalPolysPerNode=32) = 0;
 
 		//! //! Creates a Triangle Selector, optimized by an octree.
-		/** \deprecated Use createOctreeTriangleSelector instead. */
+		/** \deprecated Use createOctreeTriangleSelector instead. This method may be removed by Irrlicht 1.9. */
 		_IRR_DEPRECATED_ ITriangleSelector* createOctTreeTriangleSelector(IMesh* mesh,
 			ISceneNode* node, s32 minimalPolysPerNode=32)
 		{

include/IVideoDriver.h

@@ -512,7 +512,8 @@ namespace video
 		\param zeroTexels \deprecated If set to true, then any texels that match
 		the color key will have their color, as well as their alpha, set to zero
 		(i.e. black). This behaviour matches the legacy (buggy) behaviour prior
-		to release 1.5 and is provided for backwards compatibility only.*/
+		to release 1.5 and is provided for backwards compatibility only. 
+		This parameter may be removed by Irrlicht 1.9. */
 		virtual void makeColorKeyTexture(video::ITexture* texture,
 						video::SColor color,
 						bool zeroTexels = false) const =0;
@@ -528,7 +529,8 @@ namespace video
 		\param zeroTexels \deprecated If set to true, then any texels that match
 		the color key will have their color, as well as their alpha, set to zero
 		(i.e. black). This behaviour matches the legacy (buggy) behaviour prior
-		to release 1.5 and is provided for backwards compatibility only.*/
+		to release 1.5 and is provided for backwards compatibility only.
+		This parameter may be removed by Irrlicht 1.9. */
 		virtual void makeColorKeyTexture(video::ITexture* texture,
 				core::position2d<s32> colorKeyPixelPos,
 				bool zeroTexels = false) const =0;
@@ -1211,7 +1213,7 @@ namespace video
 		virtual IImage* createImage(ECOLOR_FORMAT format, const core::dimension2d<u32>& size) =0;
 
 		//! Creates a software image by converting it to given format from another image.
-		/** \deprecated Create an empty image and use copyTo()
+		/** \deprecated Create an empty image and use copyTo(). This method may be removed by Irrlicht 1.9.
 		\param format Desired color format of the image.
 		\param imageToCopy Image to copy to the new image.
 		\return The created image.
@@ -1220,7 +1222,7 @@ namespace video
 		_IRR_DEPRECATED_ virtual IImage* createImage(ECOLOR_FORMAT format, IImage *imageToCopy) =0;
 
 		//! Creates a software image from a part of another image.
-		/** \deprecated Create an empty image and use copyTo()
+		/** \deprecated Create an empty image and use copyTo(). This method may be removed by Irrlicht 1.9.
 		\param imageToCopy Image to copy to the new image in part.
 		\param pos Position of rectangle to copy.
 		\param size Extents of rectangle to copy.

include/irrMap.h

@@ -737,7 +737,7 @@ class map
 		return Root == 0;
 	}
 
-	//! \deprecated Use empty() instead.
+	//! \deprecated Use empty() instead. This method may be removed by Irrlicht 1.9 
 	_IRR_DEPRECATED_ bool isEmpty() const
 	{
 		return empty();