[docs] note that use of the public Heap API is discouraged (#4285)

This commit is contained in:
Jeff Bumgardner
2019-10-31 21:42:17 -07:00
committed by Jonathan Hui
parent c8eaeba6b4
commit ab97703b04
+8
View File
@@ -74,10 +74,18 @@ typedef void (*otHeapFreeFn)(void *aPointer);
// This is a temporary API and would be removed after moving heap to platform.
// TODO: Remove after moving heap to platform.
/**
* @note This API is deprecated and use of it is discouraged.
*
*/
void *otHeapCAlloc(size_t aCount, size_t aSize);
// This is a temporary API and would be removed after moving heap to platform.
// TODO: Remove after moving heap to platform.
/**
* @note This API is deprecated and use of it is discouraged.
*
*/
void otHeapFree(void *aPointer);
/**