]> rtime.felk.cvut.cz Git - zynq/linux.git/commitdiff
drm: fourcc.h: Use inline kern-doc style for struct drm_format_info
authorHyun Kwon <hyun.kwon@xilinx.com>
Wed, 14 Feb 2018 23:10:19 +0000 (15:10 -0800)
committerMichal Simek <michal.simek@xilinx.com>
Thu, 1 Mar 2018 08:20:20 +0000 (09:20 +0100)
Use the inline kern-doc style for struct drm_format_info for better
readability. This is just a preliminary change for further table update.

Signed-off-by: Hyun Kwon <hyun.kwon@xilinx.com>
Signed-off-by: Michal Simek <michal.simek@xilinx.com>
include/drm/drm_fourcc.h

index 3e86408dac9f5857daab736bf9e185e925dee78c..0fb7b8fb7fba7f7635f8de915e42cd63b069e51d 100644 (file)
@@ -30,23 +30,56 @@ struct drm_mode_fb_cmd2;
 
 /**
  * struct drm_format_info - information about a DRM format
- * @format: 4CC format identifier (DRM_FORMAT_*)
- * @depth: Color depth (number of bits per pixel excluding padding bits),
- *     valid for a subset of RGB formats only. This is a legacy field, do not
- *     use in new code and set to 0 for new formats.
- * @num_planes: Number of color planes (1 to 3)
- * @cpp: Number of bytes per pixel (per plane)
- * @hsub: Horizontal chroma subsampling factor
- * @vsub: Vertical chroma subsampling factor
- * @has_alpha: Does the format embeds an alpha component?
  */
 struct drm_format_info {
+       /**
+        * @format:
+        *
+        * 4CC format identifier (DRM_FORMAT_*)
+        */
        u32 format;
+
+       /**
+        * @depth:
+        *
+        * Color depth (number of bits per pixel excluding padding bits),
+        * valid for a subset of RGB formats only. This is a legacy field,
+        * do not use in new code and set to 0 for new formats.
+        */
        u8 depth;
+
+       /**
+        * @num_planes:
+        *
+        * Number of color planes (1 to 3)
+        */
        u8 num_planes;
+
+       /**
+        * @cpp:
+        *
+        * Number of bytes per pixel (per plane)
+        */
        u8 cpp[3];
+
+       /**
+        * @hsub:
+        *
+        * Horizontal chroma subsampling factor
+        */
        u8 hsub;
+
+       /**
+        * @vsub:
+        *
+        * Vertical chroma subsampling factor
+        */
        u8 vsub;
+       /**
+        * @has_alpha:
+        *
+        * Does the format embed an alpha component?
+        */
        bool has_alpha;
 };