Unverified Commit 8d63e85c authored by Randy Dunlap's avatar Randy Dunlap Committed by Mark Brown
Browse files

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarRichard Fitzgerald <rf@opensource.cirrus.com>
Link: https://patch.msgid.link/20251104192653.929157-1-rdunlap@infradead.org


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 123cd174

include/linux/firmware/cirrus/cs_dsp_test_utils.h

+9 −9
Original line number Diff line number Diff line
@@ -26,21 +26,21 @@ struct cs_dsp_test { 


	struct cs_dsp_test_local *local;



	/* Following members are private */

	/* private: Following members are private */

	bool saw_bus_write;

};



/**

 * struct cs_dsp_mock_alg_def - Info for creating a mock algorithm entry.

 *

 * @id		  Algorithm ID.

 * @ver;	  Algorithm version.

 * @xm_base_words XM base address in DSP words.

 * @xm_size_words XM size in DSP words.

 * @ym_base_words YM base address in DSP words.

 * @ym_size_words YM size in DSP words.

 * @zm_base_words ZM base address in DSP words.

 * @zm_size_words ZM size in DSP words.

 * @id:		   Algorithm ID.

 * @ver:	   Algorithm version.

 * @xm_base_words: XM base address in DSP words.

 * @xm_size_words: XM size in DSP words.

 * @ym_base_words: YM base address in DSP words.

 * @ym_size_words: YM size in DSP words.

 * @zm_base_words: ZM base address in DSP words.

 * @zm_size_words: ZM size in DSP words.

 */

struct cs_dsp_mock_alg_def {

	unsigned int id;