Containers: doc++

mosra · Nov 8, 2019 · 7eb7ea2 · 7eb7ea2
1 parent 1cb84a5
commit 7eb7ea2
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/Corrade/Containers/Array.h b/src/Corrade/Containers/Array.h
@@ -515,8 +515,11 @@ class Array {
         /**
          * @brief Release data storage
          *
-         * Returns the data pointer and resets internal state to default.
-         * Deleting the returned array is user responsibility.
+         * Returns the data pointer and resets internal state to be equivalent
+         * to a default-constructed instance. Deleting the returned array is
+         * user responsibility --- note the array might have a custom
+         * @ref deleter() and so @cpp delete @ce might not be always
+         * appropriate.
          */
         T* release();