This struct is lacking documentation. Add it.

Signed-off-by: Mauro Carvalho Chehab <mche...@s-opensource.com>
---
 include/media/tuner-types.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/include/media/tuner-types.h b/include/media/tuner-types.h
index aed539068d2d..55bc14093c0f 100644
--- a/include/media/tuner-types.h
+++ b/include/media/tuner-types.h
@@ -170,6 +170,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;
-- 
2.13.5

Reply via email to