From 0608cb9038c9dc44bf6dcae2b64f78459d9a3e2d Mon Sep 17 00:00:00 2001
From: Edgar Simo <bobbens@gmail.com>
Date: Wed, 6 Aug 2008 10:53:55 +0000
Subject: [PATCH] Updating documentation about NumEffects and NumPlaying.

---
 include/SDL_haptic.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/SDL_haptic.h b/include/SDL_haptic.h
index e8742cf06..8f72b5cd3 100644
--- a/include/SDL_haptic.h
+++ b/include/SDL_haptic.h
@@ -853,6 +853,10 @@ extern DECLSPEC void SDLCALL SDL_HapticClose(SDL_Haptic * haptic);
  *
  * \brief Returns the number of effects a haptic device can store.
  *
+ * On some platforms this isn't fully supported, and therefore is an
+ *  aproximation.  Always check to see if your created effect was actually
+ *  created and do not rely solely on HapticNumEffects.
+ *
  *    \param haptic The haptic device to query effect max.
  *    \return The number of effects the haptic device can store or
  *            -1 on error.
@@ -867,6 +871,9 @@ extern DECLSPEC int SDLCALL SDL_HapticNumEffects(SDL_Haptic * haptic);
  *
  * \brief Returns the number of effects a haptic device can play at the same time.
  *
+ * This is not supported on all platforms, but will always return a value.  Added
+ *  here for the sake of completness.
+ *
  *    \param haptic The haptic device to query maximum playing effect.s
  *    \return The number of effects the haptic device can play at the same time
  *            or -1 on error.