diff --git a/.editorconfig b/.editorconfig index d5e0290f..2b44e7b2 100644 --- a/.editorconfig +++ b/.editorconfig @@ -28,7 +28,7 @@ indent_size = 4 indent_style = space indent_size = 4 -[*.{dox,md}] +[*.{md}] indent_style = space indent_size = 4 trim_trailing_whitespace = false diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index d6e9b6eb..50522173 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -2,20 +2,20 @@ # NOTE: The order of this list determines the order of items in the Guides # (i.e. Pages) list in the generated documentation set(source_files - main.dox - news.dox - quick.dox - moving.dox - compile.dox - build.dox - intro.dox - context.dox - monitor.dox - window.dox - input.dox - vulkan.dox - compat.dox - internal.dox) + main.md + news.md + quick.md + moving.md + compile.md + build.md + intro.md + context.md + monitor.md + window.md + input.md + vulkan.md + compat.md + internal.md) set(extra_files DoxygenLayout.xml header.html footer.html extra.css spaces.svg) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 17bb85e6..73ba01e3 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -357,7 +357,7 @@ feature. In addition to the code, a complete feature includes: - Change log entry in `README.md`, listing all new symbols -- News page entry in `docs/news.dox`, briefly describing the feature +- News page entry in `docs/news.md`, briefly describing the feature - Guide documentation, with minimal examples, in the relevant guide in the `docs` folder - Reference documentation, with all applicable tags - Cross-references and mentions in appropriate places @@ -373,7 +373,7 @@ If it adds a new monitor property, support for it must be added to If it adds a new OpenGL, OpenGL ES or Vulkan option or extension, support for it must be added to `tests/glfwinfo.c` and the behavior of the library when -the extension is missing documented in `docs/compat.dox`. +the extension is missing documented in `docs/compat.md`. If you haven't already, read the excellent article [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/). diff --git a/docs/build.dox b/docs/build.md similarity index 99% rename from docs/build.dox rename to docs/build.md index 3d9ca845..512a17bf 100644 --- a/docs/build.dox +++ b/docs/build.md @@ -1,5 +1,3 @@ -/*! - @page build_guide Building applications @tableofcontents @@ -335,4 +333,3 @@ against it from the command-line. @note Your machine may have `libGL.*.dylib` style OpenGL library, but that is for the X Window System and will not work with the macOS native version of GLFW. -*/ diff --git a/docs/compat.dox b/docs/compat.md similarity index 99% rename from docs/compat.dox rename to docs/compat.md index 66a92614..e590ccfe 100644 --- a/docs/compat.dox +++ b/docs/compat.md @@ -1,5 +1,3 @@ -/*! - @page compat_guide Standards conformance @tableofcontents @@ -285,4 +283,3 @@ surfaces on Wayland. If any of these extensions are not available, @ref glfwGetRequiredInstanceExtensions will return an empty list and window surface creation will fail. -*/ diff --git a/docs/compile.dox b/docs/compile.md similarity index 99% rename from docs/compile.dox rename to docs/compile.md index 0c33ff0f..65a82618 100644 --- a/docs/compile.dox +++ b/docs/compile.md @@ -1,5 +1,3 @@ -/*! - @page compile_guide Compiling GLFW @tableofcontents @@ -368,4 +366,3 @@ _GLFW_GLESV2_LIBRARY. Otherwise, GLFW will use the built-in default names. GLFW. If you define any of these in your build files, make sure they are not applied to the GLFW sources. -*/ diff --git a/docs/context.dox b/docs/context.md similarity index 99% rename from docs/context.dox rename to docs/context.md index 67ff7583..eb1b2434 100644 --- a/docs/context.dox +++ b/docs/context.md @@ -1,5 +1,3 @@ -/*! - @page context_guide Context guide @tableofcontents @@ -340,4 +338,3 @@ void some_function(void) } @endcode -*/ diff --git a/docs/input.dox b/docs/input.md similarity index 99% rename from docs/input.dox rename to docs/input.md index f3ccbb2b..4c51e025 100644 --- a/docs/input.dox +++ b/docs/input.md @@ -1,5 +1,3 @@ -/*! - @page input_guide Input guide @tableofcontents @@ -980,4 +978,3 @@ The path array and its strings are only valid until the file drop callback returns, as they may have been generated specifically for that event. You need to make a deep copy of the array if you want to keep the paths. -*/ diff --git a/docs/internal.dox b/docs/internal.md similarity index 99% rename from docs/internal.dox rename to docs/internal.md index 69227568..ff281e46 100644 --- a/docs/internal.dox +++ b/docs/internal.md @@ -1,5 +1,3 @@ -/*! - @page internals_guide Internal structure @tableofcontents @@ -120,4 +118,3 @@ with a leading underscore. Examples: `_GLFW_WIN32`, `_GLFW_BUILD_DLL` -*/ diff --git a/docs/intro.dox b/docs/intro.md similarity index 99% rename from docs/intro.dox rename to docs/intro.md index 7a47e034..085cdd7e 100644 --- a/docs/intro.dox +++ b/docs/intro.md @@ -1,5 +1,3 @@ -/*! - @page intro_guide Introduction to the API @tableofcontents @@ -635,4 +633,3 @@ result in a version string like this: 3.4.0 Wayland X11 GLX Null EGL OSMesa monotonic @endcode -*/ diff --git a/docs/main.dox b/docs/main.md similarity index 99% rename from docs/main.dox rename to docs/main.md index 995c2f56..53faeea9 100644 --- a/docs/main.dox +++ b/docs/main.md @@ -1,5 +1,3 @@ -/*! - @mainpage notitle @section main_intro Introduction @@ -43,4 +41,3 @@ This documentation was generated with Doxygen. The sources for it are available in both the [source distribution](https://www.glfw.org/download.html) and [GitHub repository](https://github.com/glfw/glfw). -*/ diff --git a/docs/monitor.dox b/docs/monitor.md similarity index 99% rename from docs/monitor.dox rename to docs/monitor.md index c94ab01a..5aa5ed7f 100644 --- a/docs/monitor.dox +++ b/docs/monitor.md @@ -1,5 +1,3 @@ -/*! - @page monitor_guide Monitor guide @tableofcontents @@ -265,4 +263,3 @@ hardware gamma correction, which today is typically an approximation of sRGB gamma. This means that setting a perfectly linear ramp, or gamma 1.0, will produce the default (usually sRGB-like) behavior. -*/ diff --git a/docs/moving.dox b/docs/moving.md similarity index 99% rename from docs/moving.dox rename to docs/moving.md index 51ca4c4a..fe4f30b8 100644 --- a/docs/moving.dox +++ b/docs/moving.md @@ -1,5 +1,3 @@ -/*! - @page moving_guide Moving from GLFW 2 to 3 @tableofcontents @@ -510,4 +508,3 @@ tessellation functions, see for example | `GLFW_KEY_RALT` | `GLFW_KEY_RIGHT_ALT` | | | `GLFW_KEY_RSUPER` | `GLFW_KEY_RIGHT_SUPER` | | -*/ diff --git a/docs/news.dox b/docs/news.md similarity index 99% rename from docs/news.dox rename to docs/news.md index 2a546bc6..b316b8db 100644 --- a/docs/news.dox +++ b/docs/news.md @@ -1,5 +1,3 @@ -/*! - @page news Release notes @tableofcontents @@ -298,4 +296,3 @@ then GLFW will fail to initialize. - [Release notes for 3.1](https://www.glfw.org/docs/3.1/news.html) - [Release notes for 3.0](https://www.glfw.org/docs/3.0/news.html) -*/ diff --git a/docs/quick.dox b/docs/quick.md similarity index 99% rename from docs/quick.dox rename to docs/quick.md index 037f11e2..03688d53 100644 --- a/docs/quick.dox +++ b/docs/quick.md @@ -1,5 +1,3 @@ -/*! - @page quick_guide Getting started @tableofcontents @@ -364,4 +362,3 @@ environment you are using and is best explained by the documentation for that environment. To learn about the details that are specific to GLFW, see @ref build_guide. -*/ diff --git a/docs/vulkan.dox b/docs/vulkan.md similarity index 99% rename from docs/vulkan.dox rename to docs/vulkan.md index 167f3456..9208c006 100644 --- a/docs/vulkan.dox +++ b/docs/vulkan.md @@ -1,5 +1,3 @@ -/*! - @page vulkan_guide Vulkan guide @tableofcontents @@ -250,4 +248,3 @@ created. It is your responsibility to destroy the surface. GLFW does not destroy it for you. Call `vkDestroySurfaceKHR` function from the same extension to destroy it. -*/ diff --git a/docs/window.dox b/docs/window.md similarity index 99% rename from docs/window.dox rename to docs/window.md index 9e19808d..89883711 100644 --- a/docs/window.dox +++ b/docs/window.md @@ -1,5 +1,3 @@ -/*! - @page window_guide Window guide @tableofcontents @@ -1495,4 +1493,3 @@ which allows the driver to swap immediately even if a frame arrives a little bit late. This trades the risk of visible tears for greater framerate stability. You can check for these extensions with @ref glfwExtensionSupported. -*/