GLFW: Documentation work

From 3cf7645b96.
This commit is contained in:
Luflosi 2019-07-25 23:07:00 -05:00
parent eaf6f06047
commit 961b2c9b65
No known key found for this signature in database
GPG Key ID: 14140F703B7D8362

40
glfw/glfw3.h vendored
View File

@ -905,62 +905,62 @@ extern "C" {
#define GLFW_CLIENT_API 0x00022001 #define GLFW_CLIENT_API 0x00022001
/*! @brief Context client API major version hint and attribute. /*! @brief Context client API major version hint and attribute.
* *
* Context client API major version [hint](@ref GLFW_CLIENT_API_hint) and * Context client API major version [hint](@ref GLFW_CONTEXT_VERSION_MAJOR_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_CONTEXT_VERSION_MAJOR_attrib).
*/ */
#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002 #define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
/*! @brief Context client API minor version hint and attribute. /*! @brief Context client API minor version hint and attribute.
* *
* Context client API minor version [hint](@ref GLFW_CLIENT_API_hint) and * Context client API minor version [hint](@ref GLFW_CONTEXT_VERSION_MINOR_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_CONTEXT_VERSION_MINOR_attrib).
*/ */
#define GLFW_CONTEXT_VERSION_MINOR 0x00022003 #define GLFW_CONTEXT_VERSION_MINOR 0x00022003
/*! @brief Context client API revision number hint and attribute. /*! @brief Context client API revision number hint and attribute.
* *
* Context client API revision number [hint](@ref GLFW_CLIENT_API_hint) and * Context client API revision number
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_REVISION_attrib).
*/ */
#define GLFW_CONTEXT_REVISION 0x00022004 #define GLFW_CONTEXT_REVISION 0x00022004
/*! @brief Context robustness hint and attribute. /*! @brief Context robustness hint and attribute.
* *
* Context client API revision number [hint](@ref GLFW_CLIENT_API_hint) and * Context client API revision number [hint](@ref GLFW_CONTEXT_ROBUSTNESS_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_CONTEXT_ROBUSTNESS_attrib).
*/ */
#define GLFW_CONTEXT_ROBUSTNESS 0x00022005 #define GLFW_CONTEXT_ROBUSTNESS 0x00022005
/*! @brief OpenGL forward-compatibility hint and attribute. /*! @brief OpenGL forward-compatibility hint and attribute.
* *
* OpenGL forward-compatibility [hint](@ref GLFW_CLIENT_API_hint) and * OpenGL forward-compatibility [hint](@ref GLFW_OPENGL_FORWARD_COMPAT_hint)
* [attribute](@ref GLFW_CLIENT_API_attrib). * and [attribute](@ref GLFW_OPENGL_FORWARD_COMPAT_attrib).
*/ */
#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006 #define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
/*! @brief OpenGL debug context hint and attribute. /*! @brief OpenGL debug context hint and attribute.
* *
* OpenGL debug context [hint](@ref GLFW_CLIENT_API_hint) and * OpenGL debug context [hint](@ref GLFW_OPENGL_DEBUG_CONTEXT_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_OPENGL_DEBUG_CONTEXT_attrib).
*/ */
#define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
/*! @brief OpenGL profile hint and attribute. /*! @brief OpenGL profile hint and attribute.
* *
* OpenGL profile [hint](@ref GLFW_CLIENT_API_hint) and * OpenGL profile [hint](@ref GLFW_OPENGL_PROFILE_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_OPENGL_PROFILE_attrib).
*/ */
#define GLFW_OPENGL_PROFILE 0x00022008 #define GLFW_OPENGL_PROFILE 0x00022008
/*! @brief Context flush-on-release hint and attribute. /*! @brief Context flush-on-release hint and attribute.
* *
* Context flush-on-release [hint](@ref GLFW_CLIENT_API_hint) and * Context flush-on-release [hint](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_attrib).
*/ */
#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 #define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
/*! @brief Context error suppression hint and attribute. /*! @brief Context error suppression hint and attribute.
* *
* Context error suppression [hint](@ref GLFW_CLIENT_API_hint) and * Context error suppression [hint](@ref GLFW_CONTEXT_NO_ERROR_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_NO_ERROR_attrib).
*/ */
#define GLFW_CONTEXT_NO_ERROR 0x0002200A #define GLFW_CONTEXT_NO_ERROR 0x0002200A
/*! @brief Context creation API hint and attribute. /*! @brief Context creation API hint and attribute.
* *
* Context creation API [hint](@ref GLFW_CLIENT_API_hint) and * Context creation API [hint](@ref GLFW_CONTEXT_CREATION_API_hint) and
* [attribute](@ref GLFW_CLIENT_API_attrib). * [attribute](@ref GLFW_CONTEXT_CREATION_API_attrib).
*/ */
#define GLFW_CONTEXT_CREATION_API 0x0002200B #define GLFW_CONTEXT_CREATION_API 0x0002200B
/*! @brief Window content area scaling window /*! @brief Window content area scaling window