From de061d2e300716a3934238b322102777360ec537 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Sun, 26 Jan 2025 13:08:03 +0100
Subject: [PATCH] Fix confusing CompressedPixelStorage::dataProperties() docs.

The function got changed to return just two values instead of three in
7b5ef21bd9685b1668f6781f86b9c5f1b4cc50a9 (2018), yet the docs were never
updated.

Also clearly state the units in which row length / image height is
provided. This whole API is a mess tho, and a clear candidate for
deprecation.
---
 src/Magnum/PixelStorage.h | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/Magnum/PixelStorage.h b/src/Magnum/PixelStorage.h
index 35ecb1c18..963b7530c 100644
--- a/src/Magnum/PixelStorage.h
+++ b/src/Magnum/PixelStorage.h
@@ -83,7 +83,7 @@ class MAGNUM_EXPORT PixelStorage {
         constexpr Int rowLength() const { return _rowLength; }
 
         /**
-         * @brief Set row length
+         * @brief Set row length in pixels
          *
          * Used only on 2D and 3D images. If set to @cpp 0 @ce, size
          * information from the actual image is used. Default is @cpp 0 @ce.
@@ -97,7 +97,7 @@ class MAGNUM_EXPORT PixelStorage {
         constexpr Int imageHeight() const { return _imageHeight; }
 
         /**
-         * @brief Set image height
+         * @brief Set image height in pixels
          *
          * Used only on 3D images. If set to @cpp 0 @ce, size information from
          * the actual image is used. Default is @cpp 0 @ce.
@@ -211,11 +211,11 @@ class MAGNUM_EXPORT CompressedPixelStorage: public PixelStorage {
         /**
          * @brief Data properties for given parameters
          *
-         * Returns byte offset in each dimension, count of blocks in each
-         * dimension and block data size for image of given @p size with
-         * current pixel storage parameters. Adding byte offset and product of
-         * the vector multiplied with block data size gives minimal byte count
-         * to store given data.
+         * Returns byte offset in each direction and @cpp {rowLength, rowCount,
+ layerCount} @ce
+         * *in blocks* for image of given @p size with current pixel storage
+         * parameters. Sum of the byte offset vector gives the byte offset of
+         * first block in the data array.
          *
          * Expects @ref compressedBlockSize() and @ref compressedBlockDataSize()
          * to be non-zero.