Removed duplicate documentation.

The public, platform, native, event and utility functions are already
documented in-source.  Having duplicate documentation inevitably means
having them contradict one another.  Furthermore, most of the function
descriptions simply repeated the name of the function.
This commit is contained in:
Camilla Berglund
2013-01-23 19:47:05 +01:00
parent 75705ba2c5
commit 3e78570a31
35 changed files with 15 additions and 1028 deletions
+1 -32
View File
@@ -87,13 +87,9 @@ static const char* getErrorString(int error)
//////////////////////////////////////////////////////////////////////////
////// GLFW internal API //////
////// GLFW event API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Register error
//========================================================================
void _glfwInputError(int error, const char* format, ...)
{
if (_glfwErrorCallback)
@@ -127,10 +123,6 @@ void _glfwInputError(int error, const char* format, ...)
////// GLFW public API //////
//////////////////////////////////////////////////////////////////////////
//========================================================================
// Initialize various GLFW state
//========================================================================
GLFWAPI int glfwInit(void)
{
if (_glfwInitialized)
@@ -160,11 +152,6 @@ GLFWAPI int glfwInit(void)
return GL_TRUE;
}
//========================================================================
// Close window and shut down library
//========================================================================
GLFWAPI void glfwTerminate(void)
{
if (!_glfwInitialized)
@@ -181,12 +168,6 @@ GLFWAPI void glfwTerminate(void)
_glfwInitialized = GL_FALSE;
}
//========================================================================
// Get GLFW version
// This function may be called without GLFW having been initialized
//========================================================================
GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev)
{
if (major != NULL)
@@ -199,23 +180,11 @@ GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev)
*rev = GLFW_VERSION_REVISION;
}
//========================================================================
// Get the GLFW version string
// This function may be called without GLFW having been initialized
//========================================================================
GLFWAPI const char* glfwGetVersionString(void)
{
return _glfwPlatformGetVersionString();
}
//========================================================================
// Sets the callback function for GLFW errors
// This function may be called without GLFW having been initialized
//========================================================================
GLFWAPI void glfwSetErrorCallback(GLFWerrorfun cbfun)
{
_glfwErrorCallback = cbfun;