Function comment header cleanup.

This commit is contained in:
Camilla Berglund 2010-09-09 20:59:50 +02:00
parent 3228755895
commit 1723c4af07
8 changed files with 49 additions and 66 deletions

View File

@ -31,12 +31,8 @@
#include "internal.h" #include "internal.h"
//************************************************************************
//**** GLFW internal functions ****
//************************************************************************
//======================================================================== //========================================================================
// Enable (show) mouse cursor // Enable and disable locked cursor mode
//======================================================================== //========================================================================
static void enableMouseCursor(_GLFWwindow* window) static void enableMouseCursor(_GLFWwindow* window)
@ -46,7 +42,6 @@ static void enableMouseCursor(_GLFWwindow* window)
if (_glfwLibrary.cursorLockWindow != window) if (_glfwLibrary.cursorLockWindow != window)
return; return;
// Show mouse cursor
_glfwPlatformShowMouseCursor(window); _glfwPlatformShowMouseCursor(window);
centerPosX = window->width / 2; centerPosX = window->width / 2;
@ -71,16 +66,11 @@ static void enableMouseCursor(_GLFWwindow* window)
_glfwLibrary.cursorLockWindow = NULL; _glfwLibrary.cursorLockWindow = NULL;
} }
//========================================================================
// Disable (hide) mouse cursor
//========================================================================
static void disableMouseCursor(_GLFWwindow* window) static void disableMouseCursor(_GLFWwindow* window)
{ {
if (_glfwLibrary.cursorLockWindow) if (_glfwLibrary.cursorLockWindow)
return; return;
// Hide mouse cursor
_glfwPlatformHideMouseCursor(window); _glfwPlatformHideMouseCursor(window);
// Move cursor to the middle of the window // Move cursor to the middle of the window
@ -94,7 +84,7 @@ static void disableMouseCursor(_GLFWwindow* window)
//======================================================================== //========================================================================
// Enable sticky keys // Enable and disable sticky keys mode
//======================================================================== //========================================================================
static void enableStickyKeys(_GLFWwindow* window) static void enableStickyKeys(_GLFWwindow* window)
@ -102,10 +92,6 @@ static void enableStickyKeys(_GLFWwindow* window)
window->stickyKeys = GL_TRUE; window->stickyKeys = GL_TRUE;
} }
//========================================================================
// Disable sticky keys
//========================================================================
static void disableStickyKeys(_GLFWwindow* window) static void disableStickyKeys(_GLFWwindow* window)
{ {
int i; int i;
@ -122,7 +108,7 @@ static void disableStickyKeys(_GLFWwindow* window)
//======================================================================== //========================================================================
// Enable sticky mouse buttons // Enable and disable sticky mouse buttons mode
//======================================================================== //========================================================================
static void enableStickyMouseButtons(_GLFWwindow* window) static void enableStickyMouseButtons(_GLFWwindow* window)
@ -130,10 +116,6 @@ static void enableStickyMouseButtons(_GLFWwindow* window)
window->stickyMouseButtons = GL_TRUE; window->stickyMouseButtons = GL_TRUE;
} }
//========================================================================
// Disable sticky mouse buttons
//========================================================================
static void disableStickyMouseButtons(_GLFWwindow* window) static void disableStickyMouseButtons(_GLFWwindow* window)
{ {
int i; int i;
@ -150,7 +132,7 @@ static void disableStickyMouseButtons(_GLFWwindow* window)
//======================================================================== //========================================================================
// Enable system keys // Enable and disable system keys
//======================================================================== //========================================================================
static void enableSystemKeys(_GLFWwindow* window) static void enableSystemKeys(_GLFWwindow* window)
@ -164,10 +146,6 @@ static void enableSystemKeys(_GLFWwindow* window)
window->sysKeysDisabled = GL_FALSE; window->sysKeysDisabled = GL_FALSE;
} }
//========================================================================
// Disable system keys
//========================================================================
static void disableSystemKeys(_GLFWwindow* window) static void disableSystemKeys(_GLFWwindow* window)
{ {
if (window->sysKeysDisabled) if (window->sysKeysDisabled)
@ -181,7 +159,7 @@ static void disableSystemKeys(_GLFWwindow* window)
//======================================================================== //========================================================================
// Enable key repeat // Enable and disable key repeat
//======================================================================== //========================================================================
static void enableKeyRepeat(_GLFWwindow* window) static void enableKeyRepeat(_GLFWwindow* window)
@ -189,19 +167,15 @@ static void enableKeyRepeat(_GLFWwindow* window)
window->keyRepeat = GL_TRUE; window->keyRepeat = GL_TRUE;
} }
//========================================================================
// Disable key repeat
//========================================================================
static void disableKeyRepeat(_GLFWwindow* window) static void disableKeyRepeat(_GLFWwindow* window)
{ {
window->keyRepeat = GL_FALSE; window->keyRepeat = GL_FALSE;
} }
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//**** GLFW user functions **** ////// GLFW public API //////
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Enable certain GLFW/window/system functions // Enable certain GLFW/window/system functions

View File

@ -31,9 +31,9 @@
#include "internal.h" #include "internal.h"
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//**** GLFW user functions **** ////// GLFW public API //////
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Get a list of available video modes // Get a list of available video modes

View File

@ -33,14 +33,15 @@
#include <string.h> #include <string.h>
//************************************************************************
//**** GLFW internal functions ****
//************************************************************************
#ifndef GL_VERSION_3_0 #ifndef GL_VERSION_3_0
#define GL_NUM_EXTENSIONS 0x821D #define GL_NUM_EXTENSIONS 0x821D
#endif #endif
//////////////////////////////////////////////////////////////////////////
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Parses the OpenGL version string and extracts the version number // Parses the OpenGL version string and extracts the version number
//======================================================================== //========================================================================
@ -116,10 +117,9 @@ int _glfwStringInExtensionString(const char* string,
} }
//////////////////////////////////////////////////////////////////////////
//************************************************************************ ////// GLFW public API //////
//**** GLFW user functions **** //////////////////////////////////////////////////////////////////////////
//************************************************************************
//======================================================================== //========================================================================
// Check if an OpenGL extension is available at runtime // Check if an OpenGL extension is available at runtime

View File

@ -34,9 +34,9 @@
#include <string.h> #include <string.h>
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//**** GLFW user functions **** ////// GLFW public API //////
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Initialize various GLFW state // Initialize various GLFW state

View File

@ -31,8 +31,12 @@
#include "internal.h" #include "internal.h"
//////////////////////////////////////////////////////////////////////////
////// GLFW public API //////
//////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// // Returns the state of the specified key for the specified window
//======================================================================== //========================================================================
GLFWAPI int glfwGetKey(GLFWwindow window, int key) GLFWAPI int glfwGetKey(GLFWwindow window, int key)
@ -56,7 +60,7 @@ GLFWAPI int glfwGetKey(GLFWwindow window, int key)
//======================================================================== //========================================================================
// // Returns the state of the specified mouse button for the specified window
//======================================================================== //========================================================================
GLFWAPI int glfwGetMouseButton(GLFWwindow window, int button) GLFWAPI int glfwGetMouseButton(GLFWwindow window, int button)
@ -80,7 +84,7 @@ GLFWAPI int glfwGetMouseButton(GLFWwindow window, int button)
//======================================================================== //========================================================================
// // Returns the last reported cursor position for the specified window
//======================================================================== //========================================================================
GLFWAPI void glfwGetMousePos(GLFWwindow window, int* xpos, int* ypos) GLFWAPI void glfwGetMousePos(GLFWwindow window, int* xpos, int* ypos)
@ -98,7 +102,8 @@ GLFWAPI void glfwGetMousePos(GLFWwindow window, int* xpos, int* ypos)
//======================================================================== //========================================================================
// // Sets the cursor position relative to the position of the client area of
// the specified window
//======================================================================== //========================================================================
GLFWAPI void glfwSetMousePos(GLFWwindow window, int xpos, int ypos) GLFWAPI void glfwSetMousePos(GLFWwindow window, int xpos, int ypos)
@ -124,7 +129,7 @@ GLFWAPI void glfwSetMousePos(GLFWwindow window, int xpos, int ypos)
//======================================================================== //========================================================================
// // Returns the mouse wheel "position" for the specified window
//======================================================================== //========================================================================
GLFWAPI int glfwGetMouseWheel(GLFWwindow window) GLFWAPI int glfwGetMouseWheel(GLFWwindow window)
@ -137,7 +142,7 @@ GLFWAPI int glfwGetMouseWheel(GLFWwindow window)
//======================================================================== //========================================================================
// // Sets the mouse wheel "position" for the specified window
//======================================================================== //========================================================================
GLFWAPI void glfwSetMouseWheel(GLFWwindow window, int pos) GLFWAPI void glfwSetMouseWheel(GLFWwindow window, int pos)

View File

@ -31,9 +31,9 @@
#include "internal.h" #include "internal.h"
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//**** GLFW user functions **** ////// GLFW public API //////
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Determine joystick capabilities // Determine joystick capabilities

View File

@ -31,9 +31,9 @@
#include "internal.h" #include "internal.h"
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//**** GLFW user functions **** ////// GLFW public API //////
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Return timer value in seconds // Return timer value in seconds

View File

@ -35,15 +35,19 @@
#include <stdlib.h> #include <stdlib.h>
//************************************************************************ //========================================================================
//**** GLFW internal functions **** // Return the maxiumum of the specified values
//************************************************************************ //========================================================================
static int Max(int a, int b) static int Max(int a, int b)
{ {
return (a > b) ? a : b; return (a > b) ? a : b;
} }
//////////////////////////////////////////////////////////////////////////
////// GLFW internal API //////
//////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Clear all open window hints // Clear all open window hints
//======================================================================== //========================================================================
@ -357,9 +361,9 @@ const _GLFWfbconfig* _glfwChooseFBConfig(const _GLFWfbconfig* desired,
} }
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//**** GLFW user functions **** ////// GLFW public API //////
//************************************************************************ //////////////////////////////////////////////////////////////////////////
//======================================================================== //========================================================================
// Create the GLFW window and its associated context // Create the GLFW window and its associated context