Skip to content

Commit

Permalink
doxygen: fix undocumented parameters
Browse files Browse the repository at this point in the history
Fix several doxygen warnings from undocumented parameters.

Signed-off-by: Jordan Yates <jordan@embeint.com>
  • Loading branch information
JordanYates authored and nashif committed Jun 25, 2024
1 parent da9b308 commit f3beebb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions include/zephyr/bluetooth/classic/a2dp.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ BT_A2DP_EP_INIT(BT_AVDTP_SOURCE, _codec, _capability)
* SBC is mandatory as a2dp specification, BT_A2DP_SBC_SINK_EP_DEFAULT
* is more convenient for user to register SBC endpoint.
*
* @param _name unique structure name postfix.
* @param _freq sbc codec frequency.
* for example: A2DP_SBC_SAMP_FREQ_44100 | A2DP_SBC_SAMP_FREQ_48000
* @param _ch_mode sbc codec channel mode.
Expand Down Expand Up @@ -151,6 +152,7 @@ static struct bt_a2dp_ep _name = BT_A2DP_SOURCE_EP_INIT(BT_A2DP_SBC,\

/** @brief define the SBC default configuration.
*
* @param _name unique structure name postfix.
* @param _freq_cfg sbc codec frequency.
* for example: A2DP_SBC_SAMP_FREQ_44100
* @param _ch_mode_cfg sbc codec channel mode.
Expand All @@ -173,6 +175,7 @@ struct bt_a2dp_codec_cfg _name = {.codec_config = &bt_a2dp_codec_ie##_name,}

/** @brief define the SBC default configuration.
*
* @param _name unique structure name postfix.
* @param _freq_cfg the frequency to configure the remote same codec type endpoint.
*/
#define BT_A2DP_SBC_EP_CFG_DEFAULT(_name, _freq_cfg)\
Expand Down
2 changes: 2 additions & 0 deletions include/zephyr/tracing/tracing.h
Original file line number Diff line number Diff line change
Expand Up @@ -1765,12 +1765,14 @@
/**
* @brief Trace System heap realloc enter
* @param heap
* @param ptr
*/
#define sys_port_trace_k_heap_sys_k_realloc_enter(heap, ptr)

/**
* @brief Trace System heap realloc exit
* @param heap Heap object
* @param ptr Memory pointer
* @param ret Return value
*/
#define sys_port_trace_k_heap_sys_k_realloc_exit(heap, ptr, ret)
Expand Down

0 comments on commit f3beebb

Please sign in to comment.