From 8954af61d31421696f783bcfa247b79d3a042ef6 Mon Sep 17 00:00:00 2001
From: Camilla Berglund <elmindreda@elmindreda.org>
Date: Wed, 20 Feb 2013 19:44:52 +0100
Subject: [PATCH] Documented known bugs.

---
 include/GL/glfw3.h | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/include/GL/glfw3.h b/include/GL/glfw3.h
index 052a2d18..7ef5f5e6 100644
--- a/include/GL/glfw3.h
+++ b/include/GL/glfw3.h
@@ -904,6 +904,9 @@ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
  *  @param[in] monitor The monitor to query.
  *  @param[out] ramp Where to store the gamma ramp.
  *  @ingroup gamma
+ *
+ *  @bug This function does not yet support monitors whose original gamma ramp
+ *  has more or less than 256 entries.
  */
 GLFWAPI void glfwGetGammaRamp(GLFWmonitor* monitor, GLFWgammaramp* ramp);
 
@@ -911,6 +914,9 @@ GLFWAPI void glfwGetGammaRamp(GLFWmonitor* monitor, GLFWgammaramp* ramp);
  *  @param[in] monitor The monitor whose gamma ramp to set.
  *  @param[in] ramp The gamma ramp to use.
  *  @ingroup gamma
+ *
+ *  @bug This function does not yet support monitors whose original gamma ramp
+ *  has more or less than 256 entries.
  */
 GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
 
@@ -1207,6 +1213,9 @@ GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
  *
  *  @note This function may only be called from the main thread.
  *
+ *  @bug <strong>Mac OS X:</strong> This function is not yet implemented for
+ *  fullscreen windows.
+ *
  *  @sa glfwRestoreWindow
  */
 GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
@@ -1219,6 +1228,9 @@ GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
  *
  *  @note This function may only be called from the main thread.
  *
+ *  @bug <strong>Mac OS X:</strong> This function is not yet implemented for
+ *  fullscreen windows.
+ *
  *  @sa glfwIconifyWindow
  */
 GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
@@ -1434,6 +1446,12 @@ GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
  *  @param[in] value The new value of the specified input mode.
  *  @ingroup input
  *
+ *  @bug <strong>Windows:</strong> The @ref GLFW_CURSOR_HIDDEN value of @ref
+ *  GLFW_CURSOR_MODE is not yet implemented.
+ *
+ *  @bug <strong>Mac OS X:</strong> The @ref GLFW_CURSOR_HIDDEN value of @ref
+ *  GLFW_CURSOR_MODE is not yet implemented.
+ *
  *  @sa glfwGetInputMode
  */
 GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);