Documentation updates.

This commit is contained in:
Camilla Berglund 2013-01-07 17:22:02 +01:00
parent f0f4af4287
commit 9bfb925d1a

View File

@ -760,12 +760,12 @@ extern "C" {
*/ */
typedef void (*GLFWglproc)(void); typedef void (*GLFWglproc)(void);
/*! @brief Monitor handle type. /*! @brief Monitor object.
* @ingroup monitor * @ingroup monitor
*/ */
typedef struct GLFWmonitor GLFWmonitor; typedef struct GLFWmonitor GLFWmonitor;
/*! @brief Window handle type. /*! @brief Window object.
* @ingroup window * @ingroup window
*/ */
typedef struct GLFWwindow GLFWwindow; typedef struct GLFWwindow GLFWwindow;
@ -988,9 +988,9 @@ GLFWAPI const char* glfwGetVersionString(void);
* *
* @remarks This function may be called before @ref glfwInit. * @remarks This function may be called before @ref glfwInit.
* *
* @remarks The error callback is the preferred error retrieval mechanism, as * @note The error callback is called by the thread where the error was
* it may be provided with a more specific error description than the generic * generated. If you are using GLFW from multiple threads, your error callback
* one returned by @ref glfwErrorString. * needs to be written accordingly.
* *
* @note Because the description string provided to the callback may have been * @note Because the description string provided to the callback may have been
* generated specifically for that error, it is not guaranteed to be valid * generated specifically for that error, it is not guaranteed to be valid