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

media: tuner-types: add kernel-doc markups for struct tunertype

This struct is lacking documentation. Add it.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+15
+15
include/media/tuner-types.h
··· 171 171 struct tuner_range *ranges; 172 172 }; 173 173 174 + /** 175 + * struct tunertype - describes the known tuners. 176 + * 177 + * @name: string with the tuner's name. 178 + * @count: size of &struct tuner_params array. 179 + * @params: pointer to &struct tuner_params array. 180 + * 181 + * @min: minimal tuner frequency, in 62.5 kHz step. 182 + * should be multiplied to 16 to convert to MHz. 183 + * @max: minimal tuner frequency, in 62.5 kHz step. 184 + * Should be multiplied to 16 to convert to MHz. 185 + * @stepsize: frequency step, in Hz. 186 + * @initdata: optional byte sequence to initialize the tuner. 187 + * @sleepdata: optional byte sequence to power down the tuner. 188 + */ 174 189 struct tunertype { 175 190 char *name; 176 191 unsigned int count;