Update and improve documentation

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

diff --git a/source/core/frameformat.h b/source/core/frameformat.h
index df4363758644160c98b8d9d7e2dbc4c42f641338..4662ae8f9d2d02ec8aebe576532f13e932d67ed8 100644 (file)
--- a/source/core/frameformat.h
+++ b/source/core/frameformat.h
@@ -8,8 +8,10 @@ namespace Msp {
 namespace GL {
 
 /**
-Describes a single attachment of a framebuffer.  The values are bitfields laid
-as follows:
+Describes a single attachment of a framebuffer, including the type and index
+of the attachment point and the format of the attached texture.
+
+The values are bitfields laid as follows:
 
 nnnn nn_f _sss _ccc
       │ │    │    └╴Number of components
@@ -18,7 +20,7 @@ nnnn nn_f _sss _ccc
       └────────────╴Attachment index
 
 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 FrameAttachment: std::uint16_t
 {