Add guide section links to type reference

This commit is contained in:
Camilla Berglund 2015-11-05 09:24:16 +01:00
parent 5006ef3f56
commit 9d71eb46b8

View File

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