From 2f8e5f31a1570e629b1b1ccf5a85cd78fef2fbf0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 13 Mar 2014 23:20:03 +0100 Subject: [PATCH] Make Image*::release() documentation clearer. --- src/Magnum/Image.h | 4 ++-- src/Magnum/Trade/ImageData.h | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Magnum/Image.h b/src/Magnum/Image.h index e8d1c3866..7a7d0d4d5 100644 --- a/src/Magnum/Image.h +++ b/src/Magnum/Image.h @@ -138,8 +138,8 @@ template class Image: public AbstractImage { /** * @brief Release data storage * - * Returns the data pointer and resets internal state to default. - * Deleting the returned array is user responsibility. + * Releases the ownership of the data pointer and resets internal state + * to default. Deleting the returned array is then user responsibility. * @see @ref setData() */ unsigned char* release(); diff --git a/src/Magnum/Trade/ImageData.h b/src/Magnum/Trade/ImageData.h index c50ac610b..7ce0c1753 100644 --- a/src/Magnum/Trade/ImageData.h +++ b/src/Magnum/Trade/ImageData.h @@ -109,8 +109,8 @@ template class ImageData: public AbstractImage { /** * @brief Release data storage * - * Returns the data pointer and resets internal state to default. - * Deleting the returned array is user responsibility. + * Releases the ownership of the data pointer and resets internal state + * to default. Deleting the returned array is then user responsibility. * @see @ref data() */ unsigned char* release();