caio/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2026-08-27 10:35:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation work.

Browse Source 
Enabled Doxygen tree view, added CMake options for native and internal
modules, improved internal and native documentation.
This commit is contained in:
Camilla Berglund
2013-02-14 13:14:17 +01:00
parent 666181d923
commit 6f8084f061
5 changed files with 117 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/GL/glfw3.h
View File

@@ -783,10 +783,12 @@ GLFWAPI void glfwTerminate(void);
*/
GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
/*! @brief Returns the version string of the GLFW library.
/*! @brief Returns a string describing the compile-time configuration.
*
* The version string contains information about what compile-time options were
* enabled when the library was built.
* The format of the string is as follows:
* @arg The name of the window system API
* @arg The name of the context creation API
* @arg Any additional options or APIs
*
* @return The GLFW version string.
* @ingroup init
@@ -1062,6 +1064,10 @@ GLFWAPI void glfwWindowHint(int target, int hint);
* can use the newly created context, you need to make it current using @ref
* glfwMakeContextCurrent.
*
* @remarks To create the window at a specific position, make it initially
* invisible using the @c GLFW_VISIBLE window hint, set its position and then
* show it.
*
* @remarks For fullscreen windows the initial cursor mode is @c
* GLFW_CURSOR_CAPTURED and the screensaver is prohibited from starting. For
* regular windows the initial cursor mode is @c GLFW_CURSOR_NORMAL and the

28
include/GL/glfw3native.h
View File

@@ -39,11 +39,31 @@ extern "C" {
* Doxygen documentation
*************************************************************************/
/*! @defgroup native Native API
/*! @defgroup native Native access
*
* By using the native API, you assert that you know what you are doing and how
* to fix problems caused by using it. If you don't, you shouldn't be using
* it.
* <strong>By using the native API, you assert that you know what you are
* doing and how to fix problems caused by using it. If you don't, you
* shouldn't be using it.</strong>
*
* Before the inclusion of @ref glfw3native.h, you must define exactly one
* window API macro and exactly one context API macro. Failure to do this
* will cause a compile-time error.
*
* The available window API macros are:
* @arg @c GLFW_EXPOSE_NATIVE_WIN32
* @arg @c GLFW_EXPOSE_NATIVE_COCOA
* @arg @c GLFW_EXPOSE_NATIVE_X11
*
* The available context API macros are:
* @arg @c GLFW_EXPOSE_NATIVE_WGL
* @arg @c GLFW_EXPOSE_NATIVE_NSGL
* @arg @c GLFW_EXPOSE_NATIVE_GLX
* @arg @c GLFW_EXPOSE_NATIVE_EGL
*
* These macros select which of the native access functions are declared and
* which platform-specific headers to include. It is then up your (by
* definition platform-specific) code to handle which of these should be
* defined.
*/