Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

firmware: cs_dsp: fix kernel-doc warnings in a header file

Use correct kernel-doc format to avoid kernel-doc warnings in
nclude/linux/firmware/cirrus/cs_dsp_test_utils.h:

- mark one struct member as private: since the comment says that it is
private
- add ending ':' to struct members where needed

Warning: include/linux/firmware/cirrus/cs_dsp_test_utils.h:30 struct
member 'saw_bus_write' not described in 'cs_dsp_test'
Warning: include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'id' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'ver' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'xm_base_words' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'xm_size_words' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'ym_base_words' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'ym_size_words' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'zm_base_words' not described in 'cs_dsp_mock_alg_def'
Warning: ../include/linux/firmware/cirrus/cs_dsp_test_utils.h:53 struct
member 'zm_size_words' not described in 'cs_dsp_mock_alg_def'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Richard Fitzgerald <rf@opensource.cirrus.com>
Link: https://patch.msgid.link/20251104192653.929157-1-rdunlap@infradead.org
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Randy Dunlap and committed by
Mark Brown
8d63e85c 123cd174

+9 -9
+9 -9
include/linux/firmware/cirrus/cs_dsp_test_utils.h
··· 26 26 27 27 struct cs_dsp_test_local *local; 28 28 29 - /* Following members are private */ 29 + /* private: Following members are private */ 30 30 bool saw_bus_write; 31 31 }; 32 32 33 33 /** 34 34 * struct cs_dsp_mock_alg_def - Info for creating a mock algorithm entry. 35 35 * 36 - * @id Algorithm ID. 37 - * @ver; Algorithm version. 38 - * @xm_base_words XM base address in DSP words. 39 - * @xm_size_words XM size in DSP words. 40 - * @ym_base_words YM base address in DSP words. 41 - * @ym_size_words YM size in DSP words. 42 - * @zm_base_words ZM base address in DSP words. 43 - * @zm_size_words ZM size in DSP words. 36 + * @id: Algorithm ID. 37 + * @ver: Algorithm version. 38 + * @xm_base_words: XM base address in DSP words. 39 + * @xm_size_words: XM size in DSP words. 40 + * @ym_base_words: YM base address in DSP words. 41 + * @ym_size_words: YM size in DSP words. 42 + * @zm_base_words: ZM base address in DSP words. 43 + * @zm_size_words: ZM size in DSP words. 44 44 */ 45 45 struct cs_dsp_mock_alg_def { 46 46 unsigned int id;