Skip to content

Commit

Permalink
improve api comment
Browse files Browse the repository at this point in the history
  • Loading branch information
xianjimli committed Jan 3, 2025
1 parent 6c51789 commit f72a949
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion src/base/bitmap.h
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ bitmap_t* bitmap_create_ex3(uint32_t w, uint32_t h, uint32_t line_length, bitmap
* @param {uint8_t*} physical_data_addr 物理地址(部分硬件加速需要)。
* @param {bool_t} should_free_data 是否释放数据。
*
* @return {bitmap_t*} 返回bitmap对象
* @return {ret_t} 返回RET_OK表示成功,否则表示失败
*/
ret_t bitmap_init_ex2(bitmap_t* bitmap, uint32_t w, uint32_t h, uint32_t line_length,
bitmap_format_t format, uint8_t* data, uint8_t* physical_data_addr,
Expand Down
10 changes: 5 additions & 5 deletions src/tkc/atomic.h
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ static ret_t tk_atomic_init(tk_atomic_t* atomic, const value_t* v);
* @export none
* 原子交换操作。
*
* @param {const tk_atomic_t*} atomic 原子操作类对象。
* @param {tk_atomic_t*} atomic 原子操作类对象。
* @param {value_t*} v 交换值。
*
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
Expand All @@ -98,7 +98,7 @@ static ret_t tk_atomic_exchange(tk_atomic_t* atomic, value_t* v);
* weak版本的CAS允许偶然出乎意料的返回(比如在字段值和期待值一样的时候却返回了FALSE),
* 不过在一些循环算法中,这是可以接受的。通常它比起strong有更高的性能。
*
* @param {const tk_atomic_t*} atomic 原子操作类对象。
* @param {tk_atomic_t*} atomic 原子操作类对象。
* @param {value_t*} expect 期望值。
* @param {value_t*} desire 设定值。
*
Expand All @@ -113,7 +113,7 @@ static bool_t tk_atomic_compare_exchange_weak(tk_atomic_t* atomic, value_t* expe
* 原子比较交换操作(Compare And Swap)。
* > 如果 atomic 等于 expect,则将 atomic 改为 desire, 否则将 expect 改为 atomic。
*
* @param {const tk_atomic_t*} atomic 原子操作类对象。
* @param {tk_atomic_t*} atomic 原子操作类对象。
* @param {value_t*} expect 期望值。
* @param {value_t*} desire 设定值。
*
Expand Down Expand Up @@ -151,7 +151,7 @@ static ret_t tk_atomic_load(const tk_atomic_t* atomic, value_t* v);
* @export none
* 原子加操作。
*
* @param {const tk_atomic_t*} atomic 原子操作类对象。
* @param {tk_atomic_t*} atomic 原子操作类对象。
* @param {value_t*} v 值。
*
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
Expand All @@ -163,7 +163,7 @@ static ret_t tk_atomic_fetch_add(tk_atomic_t* atomic, value_t* v);
* @export none
* 原子减操作。
*
* @param {const tk_atomic_t*} atomic 原子操作类对象。
* @param {tk_atomic_t*} atomic 原子操作类对象。
* @param {value_t*} v 值。
*
* @return {ret_t} 返回RET_OK表示成功,否则表示失败。
Expand Down

0 comments on commit f72a949

Please sign in to comment.