Mirrors/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-02-17 21:12:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Header file documentation work

Browse Source
This commit is contained in:
Camilla Berglund
2015-10-24 20:48:46 +02:00
parent b312f5e208
commit 318e8acfae
4 changed files with 43 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
include/GLFW/glfw3native.h
View File

@@ -38,6 +38,12 @@ extern "C" {
* Doxygen documentation
*************************************************************************/
/*! @file glfw3native.h
* @brief The header of the native access functions.
*
* This is the header file of the native access functions. See @ref native for
* more information.
*/
/*! @defgroup native Native access
*
* **By using the native access functions you assert that you know what you're
@@ -48,6 +54,9 @@ extern "C" {
* window system API macro and exactly one context creation API macro. Failure
* to do this will cause a compile-time error.
*
* The chosen backends must match those the library was compiled for. Failure
* to do this will cause a link-time error.
*
* The available window API macros are:
* * `GLFW_EXPOSE_NATIVE_WIN32`
* * `GLFW_EXPOSE_NATIVE_COCOA`