Convert Doxygen tables of contents to Markdown

This commit is contained in:
Camilla Löwy 2024-02-13 22:42:49 +01:00
parent 244852a93a
commit 532bd66e7f
13 changed files with 13 additions and 13 deletions

View File

@ -1,6 +1,6 @@
# Building applications {#build_guide}
@tableofcontents
[TOC]
This is about compiling and linking applications that use GLFW. For information on
how to write such applications, start with the

View File

@ -1,6 +1,6 @@
# Standards conformance {#compat_guide}
@tableofcontents
[TOC]
This guide describes the various API extensions used by this version of GLFW.
It lists what are essentially implementation details, but which are nonetheless

View File

@ -1,6 +1,6 @@
# Compiling GLFW {#compile_guide}
@tableofcontents
[TOC]
This is about compiling the GLFW library itself. For information on how to
build applications that use GLFW, see @ref build_guide.

View File

@ -1,6 +1,6 @@
# Context guide {#context_guide}
@tableofcontents
[TOC]
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

View File

@ -1,6 +1,6 @@
# Input guide {#input_guide}
@tableofcontents
[TOC]
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

View File

@ -1,6 +1,6 @@
# Internal structure {#internals_guide}
@tableofcontents
[TOC]
There are several interfaces inside GLFW. Each interface has its own area of
responsibility and its own naming conventions.

View File

@ -1,6 +1,6 @@
# Introduction to the API {#intro_guide}
@tableofcontents
[TOC]
This guide introduces the basic concepts of GLFW and describes initialization,
error handling and API guarantees and limitations. For a broad but shallow

View File

@ -1,6 +1,6 @@
# Monitor guide {#monitor_guide}
@tableofcontents
[TOC]
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

View File

@ -1,6 +1,6 @@
# 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
changed or been removed, but does _not_ include

View File

@ -1,6 +1,6 @@
# Release notes {#news}
@tableofcontents
[TOC]
## Release notes for version 3.4 {#news_34}

View File

@ -1,6 +1,6 @@
# Getting started {#quick_guide}
@tableofcontents
[TOC]
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

View File

@ -1,6 +1,6 @@
# Vulkan guide {#vulkan_guide}
@tableofcontents
[TOC]
This guide is intended to fill the gaps between the official [Vulkan
resources](https://www.khronos.org/vulkan/) and the rest of the GLFW

View File

@ -1,6 +1,6 @@
# Window guide {#window_guide}
@tableofcontents
[TOC]
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