[Teem-commit] SF.net SVN: teem:[7224] teem/trunk/src/air/array.c

[<kin...@us...>]

Revision: 7224
          http://sourceforge.net/p/teem/code/7224
Author:   kindlmann
Date:     2024-07-23 16:51:37 +0000 (Tue, 23 Jul 2024)
Log Message:
-----------
reformatting/clarifying comment

Modified Paths:
--------------
    teem/trunk/src/air/array.c

Modified: teem/trunk/src/air/array.c
===================================================================
--- teem/trunk/src/air/array.c	2024-07-23 16:40:49 UTC (rev 7223)
+++ teem/trunk/src/air/array.c	2024-07-23 16:51:37 UTC (rev 7224)
@@ -186,17 +186,14 @@
 **
 ** Set the length of the array, allocating or freeing as needed
 **
-** returns 1 on error, otherwise 0 if okay
-** possible errors: bogus arguments, or couldn't allocate new memory segment
-**
 ** In case we can't allocate the new space, the old space is left untouched,
 ** however if the new length is smaller, the free/done callbacks will
 ** have been called on invalidated elements
 **
-** NB: this used to have a "boolean" return to indicate allocation
-** error, but almost nothing in Teem actually did the error checking.
-** Now conscientious users can look at NULL-ity of a->data to detect
-** such an error.
+** NB: this used to have a "boolean" return to indicate allocation error, but almost
+** nothing in Teem actually did the error checking. Now conscientious users can look at
+** NULL-ity of a->data to detect such an error (e.g. bogus arguments, or couldn't
+** allocate new memory segment)
 */
 void
 airArrayLenSet(airArray *a, unsigned int newlen) {

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.