zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2024-12-04 01:51:06 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarify API documentation of fluid_free()

Browse source
This commit is contained in:
derselbst 2021-04-13 21:06:38 +02:00
parent 149e08f181
commit ab4eebaf5b
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/utils/fluid_sys.c
View file

@ -279,16 +279,16 @@ error_recovery:
} }
/** /**
* Convenience wrapper for free() that satisfies at least C90 requirements. * Wrapper for free() that satisfies at least C90 requirements.
* *
* @param ptr Pointer to memory region that should be freed * @param ptr Pointer to memory region that should be freed
* *
* Especially useful when using fluidsynth with programming languages that do not
* provide malloc() and free().
*
* @note Only use this function when the API documentation explicitly says so. Otherwise use * @note Only use this function when the API documentation explicitly says so. Otherwise use
* adequate \c delete_fluid_* functions. * adequate \c delete_fluid_* functions.
* *
* @warning Calling ::free() on memory that is advised to be freed with fluid_free() results in undefined behaviour!
* (cf.: "Potential Errors Passing CRT Objects Across DLL Boundaries" found in MS Docs)
*
* @since 2.0.7 * @since 2.0.7
*/ */
void fluid_free(void* ptr) void fluid_free(void* ptr)