[PATCH v2] drm: Add documentation for struct drm_pane_size_hint

[PATCH v2] drm: Add documentation for struct drm_pane_size_hint

[abid-sayyad]

Fixed warning for the following:
./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
				'width' not described in 'drm_plane_size_hint'
./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
				'height' not described in 'drm_plane_size_hint'

Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
---
My sincere apologies for the spam and the patch subject error
Changes in v2:
- Adress review feedback regarding indentation in the fix
- Link to v1
https://lore.kernel.org/all/20240801102239.572718-1-sayyad.abid16@gmail.com/

 include/uapi/drm/drm_mode.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index d390011b89b4..9d398335d871 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -864,7 +864,13 @@ struct drm_color_lut {
  * array of struct drm_plane_size_hint.
  */
 struct drm_plane_size_hint {
+	/**
+	 * @width: width of the plane in pixels.
+	 */
 	__u16 width;
+	/**
+	 * @height: height of the plane in pixels.
+	 */
 	__u16 height;
 };

--
2.39.2

Re: [PATCH v2] drm: Add documentation for struct drm_pane_size_hint

[Jani Nikula]

On Thu, 01 Aug 2024, abid-sayyad <sayyad.abid16@gmail.com> wrote:
> Fixed warning for the following:
> ./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
> 				'width' not described in 'drm_plane_size_hint'
> ./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member
> 				'height' not described in 'drm_plane_size_hint'
>
> Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
> ---
> My sincere apologies for the spam and the patch subject error

Usually there's no need to resend, at least not immediately, because of
issues in the subject or the commit message. Many of them can be fixed
while applying, and if not, you'll be asked to fix and resend.

Reviewed-by: Jani Nikula <jani.nikula@intel.com>


> Changes in v2:
> - Adress review feedback regarding indentation in the fix
> - Link to v1
> https://lore.kernel.org/all/20240801102239.572718-1-sayyad.abid16@gmail.com/
>
>  include/uapi/drm/drm_mode.h | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
> index d390011b89b4..9d398335d871 100644
> --- a/include/uapi/drm/drm_mode.h
> +++ b/include/uapi/drm/drm_mode.h
> @@ -864,7 +864,13 @@ struct drm_color_lut {
>   * array of struct drm_plane_size_hint.
>   */
>  struct drm_plane_size_hint {
> +	/**
> +	 * @width: width of the plane in pixels.
> +	 */
>  	__u16 width;
> +	/**
> +	 * @height: height of the plane in pixels.
> +	 */
>  	__u16 height;
>  };
>
> --
> 2.39.2
>

-- 
Jani Nikula, Intel