From 71dacd8b46a2357a279e3b0a7d8e1c71d036f61d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=9C=88=E5=85=B3?= Date: Tue, 11 Feb 2025 09:31:51 +0000 Subject: [PATCH 1/5] update commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 李月关 --- .../libpurgeablemem/purgeable_memory.h | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h index 2f9cb9ef2..a71bac9af 100644 --- a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h +++ b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h @@ -50,7 +50,7 @@ extern "C" { #endif /* End of #ifdef __cplusplus */ -/* +/** * @brief Purgeable mem struct * * @since 10 @@ -58,7 +58,7 @@ extern "C" { */ typedef struct PurgMem OH_PurgeableMemory; -/* +/** * @brief: function pointer, it points to a function which is used to build content of a PurgMem obj. * * @@ -72,7 +72,7 @@ typedef struct PurgMem OH_PurgeableMemory; */ typedef bool (*OH_PurgeableMemory_ModifyFunc)(void *, size_t, void *); -/* +/** * @brief: create a PurgMem obj. * * @@ -87,7 +87,7 @@ typedef bool (*OH_PurgeableMemory_ModifyFunc)(void *, size_t, void *); OH_PurgeableMemory *OH_PurgeableMemory_Create( size_t size, OH_PurgeableMemory_ModifyFunc func, void *funcPara); -/* +/** * @brief: destroy a PurgMem obj. * * @@ -100,7 +100,7 @@ OH_PurgeableMemory *OH_PurgeableMemory_Create( */ bool OH_PurgeableMemory_Destroy(OH_PurgeableMemory *purgObj); -/* +/** * @brief: begin read a PurgMem obj. * * @@ -117,7 +117,7 @@ bool OH_PurgeableMemory_Destroy(OH_PurgeableMemory *purgObj); */ bool OH_PurgeableMemory_BeginRead(OH_PurgeableMemory *purgObj); -/* +/** * @brief: end read a PurgMem obj. * * @@ -130,7 +130,7 @@ bool OH_PurgeableMemory_BeginRead(OH_PurgeableMemory *purgObj); */ void OH_PurgeableMemory_EndRead(OH_PurgeableMemory *purgObj); -/* +/** * @brief: begin write a PurgMem obj. * * @@ -147,7 +147,7 @@ void OH_PurgeableMemory_EndRead(OH_PurgeableMemory *purgObj); */ bool OH_PurgeableMemory_BeginWrite(OH_PurgeableMemory *purgObj); -/* +/** * @brief: end write a PurgMem obj. * * @@ -160,7 +160,7 @@ bool OH_PurgeableMemory_BeginWrite(OH_PurgeableMemory *purgObj); */ void OH_PurgeableMemory_EndWrite(OH_PurgeableMemory *purgObj); -/* +/** * @brief: get content ptr of a PurgMem obj. * * @@ -175,7 +175,7 @@ void OH_PurgeableMemory_EndWrite(OH_PurgeableMemory *purgObj); */ void *OH_PurgeableMemory_GetContent(OH_PurgeableMemory *purgObj); -/* +/** * @brief: get content size of a PurgMem obj. * * @@ -188,7 +188,7 @@ void *OH_PurgeableMemory_GetContent(OH_PurgeableMemory *purgObj); */ size_t OH_PurgeableMemory_ContentSize(OH_PurgeableMemory *purgObj); -/* +/** * @brief: append a modify to a PurgMem obj. * * -- Gitee From 81ff19262ef5e585749127e20b9c90473a257e12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=9C=88=E5=85=B3?= Date: Wed, 5 Mar 2025 09:09:10 +0000 Subject: [PATCH 2/5] update commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 李月关 --- .../libpurgeablemem/purgeable_memory.h | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h index a71bac9af..ea8fa5a6f 100644 --- a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h +++ b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h @@ -77,7 +77,7 @@ typedef bool (*OH_PurgeableMemory_ModifyFunc)(void *, size_t, void *); * * * @param size: data size of a PurgMem obj's content. - * @param func: function pointer, it is used to recover data when the PurgMem obj's content is purged. + * @param func Function pointer, it is used to recover data when the PurgMem obj's content is purged. * @param funcPara: parameters used by @func. * @return: a PurgMem obj. * @@ -91,7 +91,7 @@ OH_PurgeableMemory *OH_PurgeableMemory_Create( * @brief: destroy a PurgMem obj. * * - * @param purgObj: a PurgMem obj to be destroyed. + * @param purgObj A PurgMem obj to be destroyed. * @return: true is success, while false is fail. return true if @purgObj is NULL. * If return true, @purgObj will be set to NULL to avoid Use-After-Free. * @@ -104,7 +104,7 @@ bool OH_PurgeableMemory_Destroy(OH_PurgeableMemory *purgObj); * @brief: begin read a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * @return: return true if @purgObj's content is present. * If content is purged(no present), system will recover its data, * return false if content is purged and recovered failed. @@ -121,7 +121,7 @@ bool OH_PurgeableMemory_BeginRead(OH_PurgeableMemory *purgObj); * @brief: end read a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * OS may reclaim the memory of @purgObj's content * at a later time when this function returns. * @@ -134,7 +134,7 @@ void OH_PurgeableMemory_EndRead(OH_PurgeableMemory *purgObj); * @brief: begin write a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * @return: return true if @purgObj's content is present. * if content is purged(no present), system will recover its data, * return false if content is purged and recovered failed. @@ -151,7 +151,7 @@ bool OH_PurgeableMemory_BeginWrite(OH_PurgeableMemory *purgObj); * @brief: end write a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * OS may reclaim the memory of @purgObj's content * at a later time when this function returns. * @@ -164,7 +164,7 @@ void OH_PurgeableMemory_EndWrite(OH_PurgeableMemory *purgObj); * @brief: get content ptr of a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * @return: return start address of a PurgMem obj's content. * Return NULL if @purgObj is NULL. * This function should be protect by PurgMemBeginRead()/PurgMemEndRead() @@ -179,7 +179,7 @@ void *OH_PurgeableMemory_GetContent(OH_PurgeableMemory *purgObj); * @brief: get content size of a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * @return: return content size of @purgObj. * Return 0 if @purgObj is NULL. * @@ -193,7 +193,6 @@ size_t OH_PurgeableMemory_ContentSize(OH_PurgeableMemory *purgObj); * * * @param purgObj: a PurgMem obj. - * @param size: data size of a PurgMem obj's content. * @param func: function pointer, it will modify content of @PurgMem. * @param funcPara: parameters used by @func. * @return: append result, true is success, while false is fail. -- Gitee From 15ff4dce2f13ac15e497d94b5ac9c8c479f5614c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=9C=88=E5=85=B3?= Date: Wed, 5 Mar 2025 09:28:28 +0000 Subject: [PATCH 3/5] update commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 李月关 --- commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h index ea8fa5a6f..ca3407478 100644 --- a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h +++ b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h @@ -78,7 +78,7 @@ typedef bool (*OH_PurgeableMemory_ModifyFunc)(void *, size_t, void *); * * @param size: data size of a PurgMem obj's content. * @param func Function pointer, it is used to recover data when the PurgMem obj's content is purged. - * @param funcPara: parameters used by @func. + * @param funcPara Parameters used by @func. * @return: a PurgMem obj. * * @since 10 @@ -192,7 +192,7 @@ size_t OH_PurgeableMemory_ContentSize(OH_PurgeableMemory *purgObj); * @brief: append a modify to a PurgMem obj. * * - * @param purgObj: a PurgMem obj. + * @param purgObj A PurgMem obj. * @param func: function pointer, it will modify content of @PurgMem. * @param funcPara: parameters used by @func. * @return: append result, true is success, while false is fail. -- Gitee From 757470e2ce34f05d5f05662a5b1792d437a3c457 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=9C=88=E5=85=B3?= Date: Thu, 6 Mar 2025 02:40:17 +0000 Subject: [PATCH 4/5] update commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 李月关 --- .../memory_utils/libpurgeablemem/purgeable_memory.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h index ca3407478..039130611 100644 --- a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h +++ b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h @@ -76,7 +76,7 @@ typedef bool (*OH_PurgeableMemory_ModifyFunc)(void *, size_t, void *); * @brief: create a PurgMem obj. * * - * @param size: data size of a PurgMem obj's content. + * @param size Data size of a PurgMem obj's content. * @param func Function pointer, it is used to recover data when the PurgMem obj's content is purged. * @param funcPara Parameters used by @func. * @return: a PurgMem obj. @@ -193,8 +193,8 @@ size_t OH_PurgeableMemory_ContentSize(OH_PurgeableMemory *purgObj); * * * @param purgObj A PurgMem obj. - * @param func: function pointer, it will modify content of @PurgMem. - * @param funcPara: parameters used by @func. + * @param func Function pointer, it will modify content of @PurgMem. + * @param funcPara Parameters used by @func. * @return: append result, true is success, while false is fail. * * @since 10 -- Gitee From 8d81f7b7607475c13a9f7384a74d5d627346a76d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E6=9C=88=E5=85=B3?= Date: Thu, 20 Mar 2025 03:41:01 +0000 Subject: [PATCH 5/5] update commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 李月关 --- commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h index 039130611..7d6f0ba11 100644 --- a/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h +++ b/commonlibrary/memory_utils/libpurgeablemem/purgeable_memory.h @@ -63,7 +63,7 @@ typedef struct PurgMem OH_PurgeableMemory; * * * @param void *: data ptr, points to start address of a PurgMem obj's content. - * @param size_t: data size of the content. + * @param size_t Data size of the content. * @param void *: other private parameters. * @return: build content result, true means success, while false is fail. * -- Gitee