caio/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-08-29 03:04:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Separate guide and reference documentation tags

Browse Source
This commit is contained in:
Camilla Berglund
2016-02-19 10:29:13 +01:00
parent 001c50cfc6
commit 80c203f3bb
16 changed files with 107 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/context.dox
View File

@@ -1,16 +1,19 @@
/*!
@page context Context guide
@page context_guide Context guide
@tableofcontents
This guide introduces the OpenGL and OpenGL ES context related functions of
GLFW. There are also guides for the other areas of the GLFW API.
GLFW. For details on a specific function, see the
[reference documentation](@ref context). There are also guides for the other
areas of the GLFW API.
- @ref intro
- @ref window
- @ref monitor
- @ref input
- @ref intro_guide
- @ref window_guide
- @ref vulkan_guide
- @ref monitor_guide
- @ref input_guide
@section context_object Context objects
@@ -29,7 +32,7 @@ the `glfwinfo` test program.
@note Vulkan does not have a context and the Vulkan instance is created via the
Vulkan API itself. If you will be using Vulkan to render to a window, disable
context creation by setting the [GLFW_CLIENT_API](@ref window_hints_ctx) hint to
`GLFW_NO_API`. For more information, see the @ref vulkan.
`GLFW_NO_API`. For more information, see the @ref vulkan_guide.
@subsection context_hints Context creation hints