[SVN] r3909 - branches/gsoc2008_force_feedback/include

[svn-owner at libsdl.org]

Author: bobbens
Date: 2008-08-06 02:35:09 -0700 (Wed, 06 Aug 2008)
New Revision: 3909

Modified:
   branches/gsoc2008_force_feedback/include/SDL_haptic.h
Log:
Documenting special cases.


Modified: branches/gsoc2008_force_feedback/include/SDL_haptic.h
===================================================================
--- branches/gsoc2008_force_feedback/include/SDL_haptic.h	2008-08-06 09:29:32 UTC (rev 3908)
+++ branches/gsoc2008_force_feedback/include/SDL_haptic.h	2008-08-06 09:35:09 UTC (rev 3909)
@@ -826,6 +826,11 @@
  * \brief Opens a Haptic device for usage from a Joystick device.  Still has
  * to be closed seperately to the joystick.
  *
+ * When opening from a joystick you should first close the haptic device before
+ *  closing the joystick device.  If not, on some implementations the haptic
+ *  device will also get unallocated and you'll be unable to use force feedback
+ *  on that device.
+ *
  *    \param joystick Joystick to create a haptic device from.
  *    \return A valid haptic device identifier on success or NULL on error.
  *