mirror of
https://github.com/glfw/glfw.git
synced 2024-11-24 02:55:10 +00:00
Rename Doxygen files to Markdown
This commit is contained in:
parent
e3e41ba339
commit
3e73a5c76c
@ -28,7 +28,7 @@ indent_size = 4
|
|||||||
indent_style = space
|
indent_style = space
|
||||||
indent_size = 4
|
indent_size = 4
|
||||||
|
|
||||||
[*.{dox,md}]
|
[*.{md}]
|
||||||
indent_style = space
|
indent_style = space
|
||||||
indent_size = 4
|
indent_size = 4
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
@ -2,20 +2,20 @@
|
|||||||
# NOTE: The order of this list determines the order of items in the Guides
|
# NOTE: The order of this list determines the order of items in the Guides
|
||||||
# (i.e. Pages) list in the generated documentation
|
# (i.e. Pages) list in the generated documentation
|
||||||
set(source_files
|
set(source_files
|
||||||
main.dox
|
main.md
|
||||||
news.dox
|
news.md
|
||||||
quick.dox
|
quick.md
|
||||||
moving.dox
|
moving.md
|
||||||
compile.dox
|
compile.md
|
||||||
build.dox
|
build.md
|
||||||
intro.dox
|
intro.md
|
||||||
context.dox
|
context.md
|
||||||
monitor.dox
|
monitor.md
|
||||||
window.dox
|
window.md
|
||||||
input.dox
|
input.md
|
||||||
vulkan.dox
|
vulkan.md
|
||||||
compat.dox
|
compat.md
|
||||||
internal.dox)
|
internal.md)
|
||||||
|
|
||||||
set(extra_files DoxygenLayout.xml header.html footer.html extra.css spaces.svg)
|
set(extra_files DoxygenLayout.xml header.html footer.html extra.css spaces.svg)
|
||||||
|
|
||||||
|
@ -357,7 +357,7 @@ feature.
|
|||||||
In addition to the code, a complete feature includes:
|
In addition to the code, a complete feature includes:
|
||||||
|
|
||||||
- Change log entry in `README.md`, listing all new symbols
|
- 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
|
- Guide documentation, with minimal examples, in the relevant guide in the `docs` folder
|
||||||
- Reference documentation, with all applicable tags
|
- Reference documentation, with all applicable tags
|
||||||
- Cross-references and mentions in appropriate places
|
- 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
|
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
|
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
|
If you haven't already, read the excellent article [How to Write a Git Commit
|
||||||
Message](https://chris.beams.io/posts/git-commit/).
|
Message](https://chris.beams.io/posts/git-commit/).
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page build_guide Building applications
|
@page build_guide Building applications
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
@ -335,4 +333,3 @@ against it from the command-line.
|
|||||||
@note Your machine may have `libGL.*.dylib` style OpenGL library, but that is
|
@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.
|
for the X Window System and will not work with the macOS native version of GLFW.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page compat_guide Standards conformance
|
@page compat_guide Standards conformance
|
||||||
|
|
||||||
@tableofcontents
|
@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
|
glfwGetRequiredInstanceExtensions will return an empty list and window surface
|
||||||
creation will fail.
|
creation will fail.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page compile_guide Compiling GLFW
|
@page compile_guide Compiling GLFW
|
||||||
|
|
||||||
@tableofcontents
|
@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
|
GLFW. If you define any of these in your build files, make sure they are not
|
||||||
applied to the GLFW sources.
|
applied to the GLFW sources.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page context_guide Context guide
|
@page context_guide Context guide
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
@ -340,4 +338,3 @@ void some_function(void)
|
|||||||
}
|
}
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page input_guide Input guide
|
@page input_guide Input guide
|
||||||
|
|
||||||
@tableofcontents
|
@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
|
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.
|
to make a deep copy of the array if you want to keep the paths.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page internals_guide Internal structure
|
@page internals_guide Internal structure
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
@ -120,4 +118,3 @@ with a leading underscore.
|
|||||||
|
|
||||||
Examples: `_GLFW_WIN32`, `_GLFW_BUILD_DLL`
|
Examples: `_GLFW_WIN32`, `_GLFW_BUILD_DLL`
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page intro_guide Introduction to the API
|
@page intro_guide Introduction to the API
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
@ -635,4 +633,3 @@ result in a version string like this:
|
|||||||
3.4.0 Wayland X11 GLX Null EGL OSMesa monotonic
|
3.4.0 Wayland X11 GLX Null EGL OSMesa monotonic
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@mainpage notitle
|
@mainpage notitle
|
||||||
|
|
||||||
@section main_intro Introduction
|
@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
|
in both the [source distribution](https://www.glfw.org/download.html) and
|
||||||
[GitHub repository](https://github.com/glfw/glfw).
|
[GitHub repository](https://github.com/glfw/glfw).
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page monitor_guide Monitor guide
|
@page monitor_guide Monitor guide
|
||||||
|
|
||||||
@tableofcontents
|
@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
|
gamma. This means that setting a perfectly linear ramp, or gamma 1.0, will
|
||||||
produce the default (usually sRGB-like) behavior.
|
produce the default (usually sRGB-like) behavior.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page moving_guide Moving from GLFW 2 to 3
|
@page moving_guide Moving from GLFW 2 to 3
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
@ -510,4 +508,3 @@ tessellation functions, see for example
|
|||||||
| `GLFW_KEY_RALT` | `GLFW_KEY_RIGHT_ALT` | |
|
| `GLFW_KEY_RALT` | `GLFW_KEY_RIGHT_ALT` | |
|
||||||
| `GLFW_KEY_RSUPER` | `GLFW_KEY_RIGHT_SUPER` | |
|
| `GLFW_KEY_RSUPER` | `GLFW_KEY_RIGHT_SUPER` | |
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page news Release notes
|
@page news Release notes
|
||||||
|
|
||||||
@tableofcontents
|
@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.1](https://www.glfw.org/docs/3.1/news.html)
|
||||||
- [Release notes for 3.0](https://www.glfw.org/docs/3.0/news.html)
|
- [Release notes for 3.0](https://www.glfw.org/docs/3.0/news.html)
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page quick_guide Getting started
|
@page quick_guide Getting started
|
||||||
|
|
||||||
@tableofcontents
|
@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
|
environment. To learn about the details that are specific to GLFW, see
|
||||||
@ref build_guide.
|
@ref build_guide.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page vulkan_guide Vulkan guide
|
@page vulkan_guide Vulkan guide
|
||||||
|
|
||||||
@tableofcontents
|
@tableofcontents
|
||||||
@ -250,4 +248,3 @@ created.
|
|||||||
It is your responsibility to destroy the surface. GLFW does not destroy it for
|
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.
|
you. Call `vkDestroySurfaceKHR` function from the same extension to destroy it.
|
||||||
|
|
||||||
*/
|
|
@ -1,5 +1,3 @@
|
|||||||
/*!
|
|
||||||
|
|
||||||
@page window_guide Window guide
|
@page window_guide Window guide
|
||||||
|
|
||||||
@tableofcontents
|
@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.
|
late. This trades the risk of visible tears for greater framerate stability.
|
||||||
You can check for these extensions with @ref glfwExtensionSupported.
|
You can check for these extensions with @ref glfwExtensionSupported.
|
||||||
|
|
||||||
*/
|
|
Loading…
Reference in New Issue
Block a user