File tree Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -308,6 +308,16 @@ extern flag g_globalDiscouragement; /* SET DISCOURAGEMENT */
308
308
/* Allocation and deallocation in memory pool */
309
309
void * poolFixedMalloc (long size /* bytes */ );
310
310
void * poolMalloc (long size /* bytes */ );
311
+ /*!
312
+ * \fn poolFree(void *ptr)
313
+ *
314
+ * Removes \p ptr from the \ref memUsedPool, if it is listed there. Then tries
315
+ * adding it to the \ref memFreePool. If this pool is full, it is increased by
316
+ * \ref MEM_POOL_GROW. If this fails, an error is created, else \p ptr is
317
+ * added.
318
+ * \param[in] ptr pointer to a \ref block.
319
+ * \bug calls outOfMemory, that can stack up endlessly
320
+ */
311
321
void poolFree (void * ptr );
312
322
/*!
313
323
* \fn addToUsedPool(void *ptr)
@@ -334,6 +344,7 @@ void poolFree(void *ptr);
334
344
* \post
335
345
* - \ref poolTotalFree is the current free space in bytes in both pools.
336
346
* - A full \ref block is not added to \ref memUsedPool by this function.
347
+ * \bug calls outOfMemory, that can stack up endlessly
337
348
*/
338
349
void addToUsedPool (void * ptr );
339
350
/* Purges reset memory pool usage */
You can’t perform that action at this time.
0 commit comments