media: frontend: describe nested structs

There are some nested structs on this header, with aren't
properly document them.

This should solve some warnings after the addition of
a patche at kernel-doc adding support for nested structs/unions.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

1 files changed, 17 insertions, 18 deletions

diff --git a/include/uapi/linux/dvb/frontend.h b/include/uapi/linux/dvb/frontend.h
index b297b65845d6..9dad6c66cc34 100644
--- a/include/uapi/linux/dvb/frontend.h
+++ b/include/uapi/linux/dvb/frontend.h
@@ -756,16 +756,15 @@ enum fecap_scale_params {
 /**
  * struct dtv_stats - Used for reading a DTV status property
  *
- * @scale:      Filled with enum fecap_scale_params - the scale
- *              in usage for that parameter
+ * @scale:
+ *      Filled with enum fecap_scale_params - the scale in usage
+ *      for that parameter
  *
- * The ``{unnamed_union}`` may have either one of the values below:
- *
- * %svalue
+ * @svalue:
  *      integer value of the measure, for %FE_SCALE_DECIBEL,
  *      used for dB measures. The unit is 0.001 dB.
  *
- * %uvalue
+ * @uvalue:
  *      unsigned integer value of the measure, used when @scale is
  *      either %FE_SCALE_RELATIVE or %FE_SCALE_COUNTER.
  *
@@ -828,19 +827,19 @@ struct dtv_fe_stats {
 /**
  * struct dtv_property - store one of frontend command and its value
  *
- * @cmd:        Digital TV command.
- * @reserved:   Not used.
- * @u:          Union with the values for the command.
- * @result:     Unused
- *
- * The @u union may have either one of the values below:
+ * @cmd:                Digital TV command.
+ * @reserved:           Not used.
+ * @u:                  Union with the values for the command.
+ * @u.data:             A unsigned 32 bits integer with command value.
+ * @u.buffer:           Struct to store bigger properties.
+ *                      Currently unused.
+ * @u.buffer.data:      an unsigned 32-bits array.
+ * @u.buffer.len:       number of elements of the buffer.
+ * @u.buffer.reserved1: Reserved.
+ * @u.buffer.reserved2: Reserved.
+ * @u.st:               a &struct dtv_fe_stats array of statistics.
+ * @result:             Currently unused.
  *
- * %data
- *      an unsigned 32-bits number.
- * %st
- *      a &struct dtv_fe_stats array of statistics.
- * %buffer
- *      a buffer of up to 32 characters (currently unused).
  */
 struct dtv_property {
         __u32 cmd;