From ab97703b04c7bfd0c69ca509cb9e563db427df29 Mon Sep 17 00:00:00 2001 From: Jeff Bumgardner Date: Thu, 31 Oct 2019 21:42:17 -0700 Subject: [PATCH] [docs] note that use of the public Heap API is discouraged (#4285) --- include/openthread/heap.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/openthread/heap.h b/include/openthread/heap.h index 101861953..ca93be3fe 100644 --- a/include/openthread/heap.h +++ b/include/openthread/heap.h @@ -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); /**