From 532bd66e7fe9fc0606ee9a0c432b7e82b3b89beb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Camilla=20L=C3=B6wy?= Date: Tue, 13 Feb 2024 22:42:49 +0100 Subject: [PATCH] Convert Doxygen tables of contents to Markdown --- docs/build.md | 2 +- docs/compat.md | 2 +- docs/compile.md | 2 +- docs/context.md | 2 +- docs/input.md | 2 +- docs/internal.md | 2 +- docs/intro.md | 2 +- docs/monitor.md | 2 +- docs/moving.md | 2 +- docs/news.md | 2 +- docs/quick.md | 2 +- docs/vulkan.md | 2 +- docs/window.md | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/build.md b/docs/build.md index 06085431..9566b152 100644 --- a/docs/build.md +++ b/docs/build.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 diff --git a/docs/compat.md b/docs/compat.md index 0d363a79..1c76a713 100644 --- a/docs/compat.md +++ b/docs/compat.md @@ -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 diff --git a/docs/compile.md b/docs/compile.md index 70dba5ff..5703cf80 100644 --- a/docs/compile.md +++ b/docs/compile.md @@ -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. diff --git a/docs/context.md b/docs/context.md index 755addde..bf70553b 100644 --- a/docs/context.md +++ b/docs/context.md @@ -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 diff --git a/docs/input.md b/docs/input.md index c11e7c61..5915c227 100644 --- a/docs/input.md +++ b/docs/input.md @@ -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 diff --git a/docs/internal.md b/docs/internal.md index 46fc8bae..b658d77b 100644 --- a/docs/internal.md +++ b/docs/internal.md @@ -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. diff --git a/docs/intro.md b/docs/intro.md index aa3bed01..d30ab33c 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -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 diff --git a/docs/monitor.md b/docs/monitor.md index 27cf6793..d6d83cb3 100644 --- a/docs/monitor.md +++ b/docs/monitor.md @@ -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 diff --git a/docs/moving.md b/docs/moving.md index 2f992dba..d50b7ffe 100644 --- a/docs/moving.md +++ b/docs/moving.md @@ -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 diff --git a/docs/news.md b/docs/news.md index 6cd54cef..7e9c4ed6 100644 --- a/docs/news.md +++ b/docs/news.md @@ -1,6 +1,6 @@ # Release notes {#news} -@tableofcontents +[TOC] ## Release notes for version 3.4 {#news_34} diff --git a/docs/quick.md b/docs/quick.md index f799fc59..f3498231 100644 --- a/docs/quick.md +++ b/docs/quick.md @@ -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 diff --git a/docs/vulkan.md b/docs/vulkan.md index 5eb2771e..cb67302f 100644 --- a/docs/vulkan.md +++ b/docs/vulkan.md @@ -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 diff --git a/docs/window.md b/docs/window.md index dda6638b..8ab7051f 100644 --- a/docs/window.md +++ b/docs/window.md @@ -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