From c00d057eda125b074b310d363fab448e2af8b96a Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Wed, 15 May 2013 15:01:42 +0200 Subject: [PATCH] Documented that out parameters always get set. --- include/GL/glfw3.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/GL/glfw3.h b/include/GL/glfw3.h index cd6da9e4..27cb119b 100644 --- a/include/GL/glfw3.h +++ b/include/GL/glfw3.h @@ -934,7 +934,8 @@ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun); * This function returns an array of handles for all currently connected * monitors. * - * @param[out] count The size of the returned array. + * @param[out] count The size of the returned array, or zero if an error + * occurred. * @return An array of monitor handles, or `NULL` if an error occurred. * * @note The returned array is valid only until the monitor configuration @@ -1027,7 +1028,8 @@ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun); * product of width and height). * * @param[in] monitor The monitor to query. - * @param[out] count The number of video modes in the returned array. + * @param[out] count The number of video modes in the returned array, or zero + * if an error occurred. * @return An array of video modes, or `NULL` if an error occurred. * * @note The returned array is valid only until this function is called again