[PATCH v6] drm: Add description for scdc variable

[PATCH v6] drm: Add description for scdc variable

[Shashank Sharma]

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)
V6: Make description single line (Daniel)

Cc: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: Shashank Sharma <shashank.sharma@intel.com>
---
 include/drm/drm_connector.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index f8b766d..6d3f7ba 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -133,6 +133,7 @@ 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 */
 	struct drm_scdc scdc;
 };
 
-- 
2.7.4

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Re: [PATCH v6] drm: Add description for scdc variable

[Daniel Vetter]

On Tue, Mar 28, 2017 at 10:06:19AM +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)
> V6: Make description single line (Daniel)
> 
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Signed-off-by: Shashank Sharma <shashank.sharma@intel.com>

Applied, thx.
-Daniel

> ---
>  include/drm/drm_connector.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index f8b766d..6d3f7ba 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -133,6 +133,7 @@ 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 */
>  	struct drm_scdc scdc;
>  };
>  
> -- 
> 2.7.4
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel