Commit 8030e774 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

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



This struct is lacking documentation. Add it.

Acked-by: default avatarSakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 0bd92985

include/media/tuner-types.h

+15 −0
Original line number Diff line number Diff line
@@ -171,6 +171,21 @@ struct tuner_params { 
	struct tuner_range *ranges;

};



/**

 * struct tunertype - describes the known tuners.

 *

 * @name:	string with the tuner's name.

 * @count:	size of &struct tuner_params array.

 * @params:	pointer to &struct tuner_params array.

 *

 * @min:	minimal tuner frequency, in 62.5 kHz step.

 *		should be multiplied to 16 to convert to MHz.

 * @max:	minimal tuner frequency, in 62.5 kHz step.

 *		Should be multiplied to 16 to convert to MHz.

 * @stepsize:	frequency step, in Hz.

 * @initdata:	optional byte sequence to initialize the tuner.

 * @sleepdata:	optional byte sequence to power down the tuner.

 */

struct tunertype {

	char *name;

	unsigned int count;