From d6e0a4390ca46bee12b20d3d13e89ed74790cf14 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Tue, 9 Feb 2016 07:41:48 +0100 Subject: [PATCH] Documentation work --- include/GLFW/glfw3.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index 8c2fbd21..55e292cc 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -1644,6 +1644,10 @@ GLFWAPI void glfwDefaultWindowHints(void); * glfwWindowHint or @ref glfwDefaultWindowHints, or until the library is * terminated. * + * This function does not check whether the specified hint values are valid. + * If you set hints to invalid values this will instead be reported by the next + * call to @ref glfwCreateWindow. + * * @param[in] hint The [window hint](@ref window_hints) to set. * @param[in] value The new value of the window hint. *