Skip to content

Commit 91c2b8b

Browse files
audio: fix missing buf_samples param docs in cir_buf_samples_to_wrap
Add missing @param buf_samples Doxygen description to cir_buf_samples_to_wrap_s16() and cir_buf_samples_to_wrap_s32() in audio_stream.h. Signed-off-by: Piotr Hoppe <piotr.hoppe@intel.com>
1 parent 3d855bd commit 91c2b8b

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

src/include/module/audio/audio_stream.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ struct sof_audio_stream_params {
7878
* @brief Calculates numbers of s16 samples to buffer wrap.
7979
* @param ptr Read or write pointer of circular buffer.
8080
* @param buf_start Start address of circular buffer.
81+
* @param buf_samples Total size of circular buffer in samples.
8182
* @return Number of samples to buffer wrap.
8283
*/
8384
static inline int cir_buf_samples_to_wrap_s16(const int16_t *ptr, const int16_t *buf_start,
@@ -92,6 +93,7 @@ static inline int cir_buf_samples_to_wrap_s16(const int16_t *ptr, const int16_t
9293
* @brief Calculates numbers of s32 samples to buffer wrap.
9394
* @param ptr Read or write pointer of circular buffer.
9495
* @param buf_start Start address of circular buffer.
96+
* @param buf_samples Total size of circular buffer in samples.
9597
* @return Number of samples to buffer wrap.
9698
*/
9799
static inline int cir_buf_samples_to_wrap_s32(const int32_t *ptr, const int32_t *buf_start,

0 commit comments

Comments
 (0)