Update and improve documentation

[libs/gl.git] / source / core / pixelformat.h

diff --git a/source/core/pixelformat.h b/source/core/pixelformat.h
index 71a8bd4c3de6c98994e618d3a382be4b9dbc1791..c180451403dc2af7e9f8c640a7c8384b04eb85e7 100644 (file)
--- a/source/core/pixelformat.h
+++ b/source/core/pixelformat.h
@@ -9,8 +9,9 @@ namespace Msp {
 namespace GL {
 
 /**
-Identifies the components of a pixel, without type information.  The values
-are bitfields laid as follows:
+Identifies the components of a pixel, without type information.
+
+The values are bitfields laid as follows:
 
 _grs dccc
  │││ │  └╴Number of components
@@ -20,7 +21,7 @@ _grs dccc
  └───────╴Grayscale flag
 
 This information is presented for internal documentation purposes only; it is
-inadvisable for programs to rely on it.
+inadvisable for applications to rely on it.
 */
 enum PixelComponents
 {
@@ -37,8 +38,9 @@ enum PixelComponents
 };
 
 /**
-Identifies a pixel format, with components and type.  The values are bitfields
-laid as follows:
+Identifies a pixel format, with components and type.
+
+The values are bitfields laid as follows:
 
 tnfg ssss cccc cccc
 ││││    │         └╴Components (see PixelComponents)
@@ -49,7 +51,7 @@ tnfg ssss cccc cccc
 └──────────────────╴sRGB flag
 
 This information is presented for internal documentation purposes only; it is
-inadvisable for programs to rely on it.
+inadvisable for applications to rely on it.
 */
 enum PixelFormat
 {