Documentation work

[ci skip]
This commit is contained in:
Camilla Berglund 2016-02-08 16:23:44 +01:00
parent 710586367c
commit 8c4ce9a3de

View File

@ -52,8 +52,8 @@ GLFW itself needs only the headers and libraries for your window system. It
does not need the headers for any context creation API (WGL, GLX, EGL, NSGL) or does not need the headers for any context creation API (WGL, GLX, EGL, NSGL) or
rendering API (OpenGL, OpenGL ES, Vulkan) to enable support for them. rendering API (OpenGL, OpenGL ES, Vulkan) to enable support for them.
GLFW bundles a number of dependencies in the `deps/` directory. These are only The examples and test programs depend on a number of tiny libraries. These are
used by the tests and examples and are not required to build the library. located in the `deps/` directory.
- [getopt\_port](https://github.com/kimgr/getopt_port/) for examples - [getopt\_port](https://github.com/kimgr/getopt_port/) for examples
with command-line options with command-line options
@ -68,6 +68,9 @@ used by the tests and examples and are not required to build the library.
The Vulkan example additionally requires the Vulkan SDK to be installed, or it The Vulkan example additionally requires the Vulkan SDK to be installed, or it
will not be included in the build. will not be included in the build.
The documentation is generated with [Doxygen](http://doxygen.org/). If CMake
does not find Doxygen, the documentation will not be generated.
## Changelog ## Changelog