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

drm: fourcc: Convert drm_format_info kerneldoc to in-line member documentation

In-line member documentation seems to be desired way of documenting
structure members.

This change had been suggested by Daniel Vetter here:
https://lists.freedesktop.org/archives/dri-devel/2018-October/192176.html

Signed-off-by: Alexandru Gheorghe <alexandru-cosmin.gheorghe@arm.com>
Reviewed-by: Maxime Ripard <maxime.ripard@bootlin.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20181019105752.17741-2-alexandru-cosmin.gheorghe@arm.com

+20 -10
+20 -10
include/drm/drm_fourcc.h
··· 52 52 53 53 /** 54 54 * struct drm_format_info - information about a DRM format 55 - * @format: 4CC format identifier (DRM_FORMAT_*) 56 - * @depth: Color depth (number of bits per pixel excluding padding bits), 57 - * valid for a subset of RGB formats only. This is a legacy field, do not 58 - * use in new code and set to 0 for new formats. 59 - * @num_planes: Number of color planes (1 to 3) 60 - * @cpp: Number of bytes per pixel (per plane) 61 - * @hsub: Horizontal chroma subsampling factor 62 - * @vsub: Vertical chroma subsampling factor 63 - * @has_alpha: Does the format embeds an alpha component? 64 - * @is_yuv: Is it a YUV format? 65 55 */ 66 56 struct drm_format_info { 57 + /** @format: 4CC format identifier (DRM_FORMAT_*) */ 67 58 u32 format; 59 + 60 + /** 61 + * @depth: 62 + * 63 + * Color depth (number of bits per pixel excluding padding bits), 64 + * valid for a subset of RGB formats only. This is a legacy field, do 65 + * not use in new code and set to 0 for new formats. 66 + */ 68 67 u8 depth; 68 + 69 + /** @num_planes: Number of color planes (1 to 3) */ 69 70 u8 num_planes; 71 + 72 + /** @cpp: Number of bytes per pixel (per plane) */ 70 73 u8 cpp[3]; 74 + 75 + /** @hsub: Horizontal chroma subsampling factor */ 71 76 u8 hsub; 77 + /** @vsub: Vertical chroma subsampling factor */ 72 78 u8 vsub; 79 + 80 + /** @has_alpha: Does the format embeds an alpha component? */ 73 81 bool has_alpha; 82 + 83 + /** @is_yuv: Is it a YUV format? */ 74 84 bool is_yuv; 75 85 }; 76 86