mirror of
https://github.com/glfw/glfw.git
synced 2024-11-09 16:41:48 +00:00
Convert Doxygen tables of contents to Markdown
This commit is contained in:
parent
244852a93a
commit
532bd66e7f
@ -1,6 +1,6 @@
|
|||||||
# Building applications {#build_guide}
|
# Building applications {#build_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This is about compiling and linking applications that use GLFW. For information on
|
This is about compiling and linking applications that use GLFW. For information on
|
||||||
how to write such applications, start with the
|
how to write such applications, start with the
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Standards conformance {#compat_guide}
|
# Standards conformance {#compat_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide describes the various API extensions used by this version of GLFW.
|
This guide describes the various API extensions used by this version of GLFW.
|
||||||
It lists what are essentially implementation details, but which are nonetheless
|
It lists what are essentially implementation details, but which are nonetheless
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Compiling GLFW {#compile_guide}
|
# Compiling GLFW {#compile_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This is about compiling the GLFW library itself. For information on how to
|
This is about compiling the GLFW library itself. For information on how to
|
||||||
build applications that use GLFW, see @ref build_guide.
|
build applications that use GLFW, see @ref build_guide.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Context guide {#context_guide}
|
# Context guide {#context_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide introduces the OpenGL and OpenGL ES context related functions of
|
This guide introduces the OpenGL and OpenGL ES context related functions of
|
||||||
GLFW. For details on a specific function in this category, see the @ref
|
GLFW. For details on a specific function in this category, see the @ref
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Input guide {#input_guide}
|
# Input guide {#input_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide introduces the input related functions of GLFW. For details on
|
This guide introduces the input related functions of GLFW. For details on
|
||||||
a specific function in this category, see the @ref input. There are also guides
|
a specific function in this category, see the @ref input. There are also guides
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Internal structure {#internals_guide}
|
# Internal structure {#internals_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
There are several interfaces inside GLFW. Each interface has its own area of
|
There are several interfaces inside GLFW. Each interface has its own area of
|
||||||
responsibility and its own naming conventions.
|
responsibility and its own naming conventions.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Introduction to the API {#intro_guide}
|
# Introduction to the API {#intro_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide introduces the basic concepts of GLFW and describes initialization,
|
This guide introduces the basic concepts of GLFW and describes initialization,
|
||||||
error handling and API guarantees and limitations. For a broad but shallow
|
error handling and API guarantees and limitations. For a broad but shallow
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Monitor guide {#monitor_guide}
|
# Monitor guide {#monitor_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide introduces the monitor related functions of GLFW. For details on
|
This guide introduces the monitor related functions of GLFW. For details on
|
||||||
a specific function in this category, see the @ref monitor. There are also
|
a specific function in this category, see the @ref monitor. There are also
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Moving from GLFW 2 to 3 {#moving_guide}
|
# Moving from GLFW 2 to 3 {#moving_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This is a transition guide for moving from GLFW 2 to 3. It describes what has
|
This is a transition guide for moving from GLFW 2 to 3. It describes what has
|
||||||
changed or been removed, but does _not_ include
|
changed or been removed, but does _not_ include
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Release notes {#news}
|
# Release notes {#news}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
|
|
||||||
## Release notes for version 3.4 {#news_34}
|
## Release notes for version 3.4 {#news_34}
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Getting started {#quick_guide}
|
# Getting started {#quick_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide takes you through writing a small application using GLFW 3. The
|
This guide takes you through writing a small application using GLFW 3. The
|
||||||
application will create a window and OpenGL context, render a rotating triangle
|
application will create a window and OpenGL context, render a rotating triangle
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Vulkan guide {#vulkan_guide}
|
# Vulkan guide {#vulkan_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide is intended to fill the gaps between the official [Vulkan
|
This guide is intended to fill the gaps between the official [Vulkan
|
||||||
resources](https://www.khronos.org/vulkan/) and the rest of the GLFW
|
resources](https://www.khronos.org/vulkan/) and the rest of the GLFW
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Window guide {#window_guide}
|
# Window guide {#window_guide}
|
||||||
|
|
||||||
@tableofcontents
|
[TOC]
|
||||||
|
|
||||||
This guide introduces the window related functions of GLFW. For details on
|
This guide introduces the window related functions of GLFW. For details on
|
||||||
a specific function in this category, see the @ref window. There are also
|
a specific function in this category, see the @ref window. There are also
|
||||||
|
Loading…
Reference in New Issue
Block a user