[PATCH v5] drm: Add description for scdc variable

[Sharma, Shashank]

V6: https://patchwork.freedesktop.org/patch/146749/ 

Regards
Shashank
-----Original Message-----
From: Daniel Vetter [mailto:daniel.vetter at ffwll.ch] On Behalf Of Daniel Vetter
Sent: Tuesday, March 28, 2017 9:54 AM
To: Sharma, Shashank <shashank.sharma at intel.com>
Cc: dri-devel at lists.freedesktop.org; Daniel Vetter <daniel at ffwll.ch>
Subject: Re: [PATCH v5] drm: Add description for scdc variable

On Tue, Mar 28, 2017 at 09:17:25AM +0300, Shashank Sharma wrote:
> This patch adds description about 'scdc' variable in drm_hdmi_info 
> structure, to fix this warning during doc-build.
> 
> "drm_connector.h:140: warning: No description found for parameter 'scdc'"
> 
> V2: Rebase
> V3: Added extra *
> V4: Removed merged conflict
> V5: Removed extra line at start of structure (Daniel)
> 
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Signed-off-by: Shashank Sharma <shashank.sharma at intel.com>
> ---
>  include/drm/drm_connector.h | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h 
> index f8b766d..b3a5443 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -133,6 +133,9 @@ struct drm_scdc {
>   * This information is available in CEA-861-F extension blocks (like HF-VSDB).
>   */
>  struct drm_hdmi_info {
> +	/**
> +	 * @scdc: sink's scdc support and capabilities
> +	 */

	/** @scdc: sink's scdc support and capabilities */

I think this looks better as a one-line, which was kinda why I asked for
v5 ... care to respin once more?

/me feeling really sorry
-Daniel



>  	struct drm_scdc scdc;
>  };
>  
> --
> 2.7.4
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch