소스 검색

Documentation work.

Camilla Berglund 12 년 전
부모
커밋
f5f55e3ff8
3개의 변경된 파일19개의 추가작업 그리고 12개의 파일을 삭제
  1. 8 2
      docs/monitor.dox
  2. 10 9
      include/GLFW/glfw3.h
  3. 1 1
      include/GLFW/glfw3native.h

+ 8 - 2
docs/monitor.dox

@@ -49,14 +49,20 @@ const GLFWvidmode* mode = glfwGetVideoMode(monitor);
 @section monitor_size Monitor physical size
 
 The physical size in millimetres of a monitor, or an approximation of it, can be
-retrieved with @ref glfwGetMonitorPhysicalSize.  This can, for example, be used
-together with the current video mode to calculate DPI.
+retrieved with @ref glfwGetMonitorPhysicalSize.  
 
 @code
 int widthMM, heightMM;
 glfwGetMonitorPhysicalSize(monitor, &widthMM, &heightMM);
 @endcode
 
+This can, for example, be used together with the current video mode to calculate
+the DPI of a monitor. 
+
+@code
+const double dpi = mode->width / (widthMM / 25.4);
+@endcode
+
 
 @section monitor_name Monitor name
 

+ 10 - 9
include/GLFW/glfw3.h

@@ -45,21 +45,22 @@ extern "C" {
  */
 /*! @defgroup error Error handling
  */
-/*! @defgroup gamma Gamma ramp support
- */
 /*! @defgroup init Initialization and version information
  */
 /*! @defgroup input Input handling
  */
 /*! @defgroup monitor Monitor handling
+ *
+ *  This is the reference documentation for monitor related functions and types.
+ *  For more information, see the @ref monitor.
  */
 /*! @defgroup time Time input
  */
 /*! @defgroup window Window handling
  *
- *  This is the reference documentation for the window handling API, including
- *  creation, deletion and event polling.  For more information, see the
- *  [article on window handling](@ref window).
+ *  This is the reference documentation for window related functions and types,
+ *  including creation, deletion and event polling.  For more information, see
+ *  the @ref window.
  */
 
 
@@ -818,7 +819,7 @@ typedef struct
  *
  *  @sa glfwGetGammaRamp glfwSetGammaRamp
  *
- *  @ingroup gamma
+ *  @ingroup monitor
  */
 typedef struct
 {
@@ -1124,7 +1125,7 @@ GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
  *  @param[in] monitor The monitor whose gamma ramp to set.
  *  @param[in] gamma The desired exponent.
  *
- *  @ingroup gamma
+ *  @ingroup monitor
  */
 GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
 
@@ -1138,7 +1139,7 @@ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
  *  @note The value arrays of the returned ramp are allocated and freed by GLFW.
  *  You should not free them yourself.
  *
- *  @ingroup gamma
+ *  @ingroup monitor
  */
 GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
 
@@ -1151,7 +1152,7 @@ GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
  *
  *  @note Gamma ramp sizes other than 256 are not supported by all hardware.
  *
- *  @ingroup gamma
+ *  @ingroup monitor
  */
 GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
 

+ 1 - 1
include/GLFW/glfw3native.h

@@ -41,7 +41,7 @@ extern "C" {
 
 /*! @defgroup native Native access
  *
- *  **By using the native API, you assert that you know what you are doing and
+ *  **By using the native API, you assert that you know what you're doing and
  *  how to fix problems caused by using it.  If you don't, you shouldn't be
  *  using it.**
  *