diff --git a/include/GLFW/glfw3.h b/include/GLFW/glfw3.h index f8af3030..19816c19 100644 --- a/include/GLFW/glfw3.h +++ b/include/GLFW/glfw3.h @@ -746,6 +746,8 @@ typedef void (*GLFWglproc)(void); * * Opaque monitor object. * + * @see @ref monitor_object + * * @ingroup monitor */ typedef struct GLFWmonitor GLFWmonitor; @@ -754,6 +756,8 @@ typedef struct GLFWmonitor GLFWmonitor; * * Opaque window object. * + * @see @ref window_object + * * @ingroup window */ typedef struct GLFWwindow GLFWwindow; @@ -762,6 +766,8 @@ typedef struct GLFWwindow GLFWwindow; * * Opaque cursor object. * + * @see @ref cursor_object + * * @ingroup cursor */ typedef struct GLFWcursor GLFWcursor; @@ -773,6 +779,7 @@ typedef struct GLFWcursor GLFWcursor; * @param[in] error An [error code](@ref errors). * @param[in] description A UTF-8 encoded string describing the error. * + * @sa @ref error_handling * @sa glfwSetErrorCallback * * @ingroup init @@ -789,6 +796,7 @@ typedef void (* GLFWerrorfun)(int,const char*); * @param[in] ypos The new y-coordinate, in screen coordinates, of the * upper-left corner of the client area of the window. * + * @sa @ref window_pos * @sa glfwSetWindowPosCallback * * @ingroup window @@ -803,6 +811,7 @@ typedef void (* GLFWwindowposfun)(GLFWwindow*,int,int); * @param[in] width The new width, in screen coordinates, of the window. * @param[in] height The new height, in screen coordinates, of the window. * + * @sa @ref window_size * @sa glfwSetWindowSizeCallback * * @ingroup window @@ -815,6 +824,7 @@ typedef void (* GLFWwindowsizefun)(GLFWwindow*,int,int); * * @param[in] window The window that the user attempted to close. * + * @sa @ref window_close * @sa glfwSetWindowCloseCallback * * @ingroup window @@ -827,6 +837,7 @@ typedef void (* GLFWwindowclosefun)(GLFWwindow*); * * @param[in] window The window whose content needs to be refreshed. * + * @sa @ref window_refresh * @sa glfwSetWindowRefreshCallback * * @ingroup window @@ -841,6 +852,7 @@ typedef void (* GLFWwindowrefreshfun)(GLFWwindow*); * @param[in] focused `GLFW_TRUE` if the window was given input focus, or * `GLFW_FALSE` if it lost it. * + * @sa @ref window_focus * @sa glfwSetWindowFocusCallback * * @ingroup window @@ -856,6 +868,7 @@ typedef void (* GLFWwindowfocusfun)(GLFWwindow*,int); * @param[in] iconified `GLFW_TRUE` if the window was iconified, or * `GLFW_FALSE` if it was restored. * + * @sa @ref window_iconify * @sa glfwSetWindowIconifyCallback * * @ingroup window @@ -871,6 +884,7 @@ typedef void (* GLFWwindowiconifyfun)(GLFWwindow*,int); * @param[in] width The new width, in pixels, of the framebuffer. * @param[in] height The new height, in pixels, of the framebuffer. * + * @sa @ref window_fbsize * @sa glfwSetFramebufferSizeCallback * * @ingroup window @@ -888,6 +902,7 @@ typedef void (* GLFWframebuffersizefun)(GLFWwindow*,int,int); * @param[in] mods Bit field describing which [modifier keys](@ref mods) were * held down. * + * @sa @ref input_mouse_button * @sa glfwSetMouseButtonCallback * * @ingroup input @@ -902,6 +917,7 @@ typedef void (* GLFWmousebuttonfun)(GLFWwindow*,int,int,int); * @param[in] xpos The new x-coordinate, in screen coordinates, of the cursor. * @param[in] ypos The new y-coordinate, in screen coordinates, of the cursor. * + * @sa @ref cursor_pos * @sa glfwSetCursorPosCallback * * @ingroup input @@ -916,6 +932,7 @@ typedef void (* GLFWcursorposfun)(GLFWwindow*,double,double); * @param[in] entered `GLFW_TRUE` if the cursor entered the window's client * area, or `GLFW_FALSE` if it left it. * + * @sa @ref cursor_enter * @sa glfwSetCursorEnterCallback * * @ingroup input @@ -930,6 +947,7 @@ typedef void (* GLFWcursorenterfun)(GLFWwindow*,int); * @param[in] xoffset The scroll offset along the x-axis. * @param[in] yoffset The scroll offset along the y-axis. * + * @sa @ref scrolling * @sa glfwSetScrollCallback * * @ingroup input @@ -947,6 +965,7 @@ typedef void (* GLFWscrollfun)(GLFWwindow*,double,double); * @param[in] mods Bit field describing which [modifier keys](@ref mods) were * held down. * + * @sa @ref input_key * @sa glfwSetKeyCallback * * @ingroup input @@ -960,6 +979,7 @@ typedef void (* GLFWkeyfun)(GLFWwindow*,int,int,int,int); * @param[in] window The window that received the event. * @param[in] codepoint The Unicode code point of the character. * + * @sa @ref input_char * @sa glfwSetCharCallback * * @ingroup input @@ -978,6 +998,7 @@ typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int); * @param[in] mods Bit field describing which [modifier keys](@ref mods) were * held down. * + * @sa @ref input_char * @sa glfwSetCharModsCallback * * @ingroup input @@ -992,6 +1013,7 @@ typedef void (* GLFWcharmodsfun)(GLFWwindow*,unsigned int,int); * @param[in] count The number of dropped files. * @param[in] paths The UTF-8 encoded file and/or directory path names. * + * @sa @ref path_drop * @sa glfwSetDropCallback * * @ingroup input @@ -1005,6 +1027,7 @@ typedef void (* GLFWdropfun)(GLFWwindow*,int,const char**); * @param[in] monitor The monitor that was connected or disconnected. * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. * + * @sa @ref monitor_event * @sa glfwSetMonitorCallback * * @ingroup monitor @@ -1015,6 +1038,9 @@ typedef void (* GLFWmonitorfun)(GLFWmonitor*,int); * * This describes a single video mode. * + * @sa @ref monitor_modes + * @sa glfwGetVideoMode glfwGetVideoModes + * * @ingroup monitor */ typedef struct GLFWvidmode @@ -1043,6 +1069,7 @@ typedef struct GLFWvidmode * * This describes the gamma ramp for a monitor. * + * @sa @ref monitor_gamma * @sa glfwGetGammaRamp glfwSetGammaRamp * * @ingroup monitor @@ -1064,6 +1091,8 @@ typedef struct GLFWgammaramp } GLFWgammaramp; /*! @brief Image data. + * + * @sa @ref cursor_custom */ typedef struct GLFWimage {