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.
Showing the changes to include/uapi/linux (1 of 1 file). Show all
Unified · Split
| @@ -756,16 +756,15 @@ enum fecap_scale_params { · 755 unmodified lines | ||
| 756 | 756 | /** |
| 757 | 757 | * struct dtv_stats - Used for reading a DTV status property |
| 758 | 758 | * |
| 759 | − * @scale: Filled with enum fecap_scale_params - the scale | |
| 760 | − * in usage for that parameter | |
| 759 | + * @scale: | |
| 760 | + * Filled with enum fecap_scale_params - the scale in usage | |
| 761 | + * for that parameter | |
| 761 | 762 | * |
| 762 | − * The ``{unnamed_union}`` may have either one of the values below: | |
| 763 | − * | |
| 764 | − * %svalue | |
| 763 | + * @svalue: | |
| 765 | 764 | * integer value of the measure, for %FE_SCALE_DECIBEL, |
| 766 | 765 | * used for dB measures. The unit is 0.001 dB. |
| 767 | 766 | * |
| 768 | − * %uvalue | |
| 767 | + * @uvalue: | |
| 769 | 768 | * unsigned integer value of the measure, used when @scale is |
| 770 | 769 | * either %FE_SCALE_RELATIVE or %FE_SCALE_COUNTER. |
| 771 | 770 | * |
| @@ -828,19 +827,19 @@ struct dtv_fe_stats { · 56 unmodified lines | ||
| 828 | 827 | /** |
| 829 | 828 | * struct dtv_property - store one of frontend command and its value |
| 830 | 829 | * |
| 831 | − * @cmd: Digital TV command. | |
| 832 | − * @reserved: Not used. | |
| 833 | − * @u: Union with the values for the command. | |
| 834 | − * @result: Unused | |
| 835 | − * | |
| 836 | − * The @u union may have either one of the values below: | |
| 830 | + * @cmd: Digital TV command. | |
| 831 | + * @reserved: Not used. | |
| 832 | + * @u: Union with the values for the command. | |
| 833 | + * @u.data: A unsigned 32 bits integer with command value. | |
| 834 | + * @u.buffer: Struct to store bigger properties. | |
| 835 | + * Currently unused. | |
| 836 | + * @u.buffer.data: an unsigned 32-bits array. | |
| 837 | + * @u.buffer.len: number of elements of the buffer. | |
| 838 | + * @u.buffer.reserved1: Reserved. | |
| 839 | + * @u.buffer.reserved2: Reserved. | |
| 840 | + * @u.st: a &struct dtv_fe_stats array of statistics. | |
| 841 | + * @result: Currently unused. | |
| 837 | 842 | * |
| 838 | − * %data | |
| 839 | − * an unsigned 32-bits number. | |
| 840 | − * %st | |
| 841 | − * a &struct dtv_fe_stats array of statistics. | |
| 842 | − * %buffer | |
| 843 | − * a buffer of up to 32 characters (currently unused). | |
| 844 | 843 | */ |
| 845 | 844 | struct dtv_property { |
| 846 | 845 | __u32 cmd; |