Convert Doxygen tables of contents to Markdown

master
Camilla Löwy ago%!(EXTRA string=1 year)
parent 244852a93a
commit 532bd66e7f
  1. 2
      docs/build.md
  2. 2
      docs/compat.md
  3. 2
      docs/compile.md
  4. 2
      docs/context.md
  5. 2
      docs/input.md
  6. 2
      docs/internal.md
  7. 2
      docs/intro.md
  8. 2
      docs/monitor.md
  9. 2
      docs/moving.md
  10. 2
      docs/news.md
  11. 2
      docs/quick.md
  12. 2
      docs/vulkan.md
  13. 2
      docs/window.md

@ -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

@ -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

@ -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.

@ -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

@ -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

@ -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.

@ -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

@ -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

@ -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

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

@ -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

@ -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

@ -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

Loading…
Cancel
Save