From 06289110e79ad5d0f166be7355cdeddd1323af94 Mon Sep 17 00:00:00 2001 From: Camilla Berglund Date: Sun, 24 Nov 2013 23:31:26 +0100 Subject: [PATCH] Documented utility functions. --- src/internal.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/internal.h b/src/internal.h index e5f29e25..8a24959a 100644 --- a/src/internal.h +++ b/src/internal.h @@ -754,11 +754,18 @@ void _glfwAllocGammaArrays(GLFWgammaramp* ramp, unsigned int size); */ void _glfwFreeGammaArrays(GLFWgammaramp* ramp); -/*! @ingroup utility +/*! @brief Allocates and returns a monitor object with the specified name + * and dimensions. + * @param[in] name The name of the monitor. + * @param[in] widthMM The width, in mm, of the monitor's display area. + * @param[in] heightMM The height, in mm, of the monitor's display area. + * @return The newly created object. + * @ingroup utility */ _GLFWmonitor* _glfwCreateMonitor(const char* name, int widthMM, int heightMM); -/*! @ingroup utility +/*! @brief Frees a monitor object and any data associated with it. + * @ingroup utility */ void _glfwDestroyMonitor(_GLFWmonitor* monitor);