caio/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-08-28 11:35:54 +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

19
docs/intro.dox
View File

@@ -1,18 +1,21 @@
/*!
@page intro Introduction to the API
@page intro_guide Introduction to the API
@tableofcontents
This guide introduces the basic concepts of GLFW and describes initialization,
This guide introduces the basic concepts of GLFW and describes initialization reference
error handling and API guarantees and limitations. For a broad but shallow
tutorial, see @ref quick instead. There are also guides for the other areas of
GLFW.
tutorial, see @ref quick_guide instead. For details on a specific function, see the
[reference documentation](@ref init).
- @ref window
- @ref context
- @ref monitor
- @ref input
There are also guides for the other areas of GLFW.
- @ref window_guide
- @ref context_guide
- @ref vulkan_guide
- @ref monitor_guide
- @ref input_guide
@section intro_init Initialization and termination