[PATCH v2] drm: Add description for scdc variable

[PATCH v2] 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

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

diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index f8b766d..9fba967 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -133,6 +133,8 @@ 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 v2] drm: Add description for scdc variable

[Daniel Vetter]

On Sat, Mar 25, 2017 at 11:21:29AM +0200, 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
> 
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Signed-off-by: Shashank Sharma <shashank.sharma@intel.com>

Since you're bikeshedding this to v4 already, might as well jump in too
:-)
> ---
>  include/drm/drm_connector.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index f8b766d..9fba967 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -133,6 +133,8 @@ struct drm_scdc {
>   * This information is available in CEA-861-F extension blocks (like HF-VSDB).
>   */
>  struct drm_hdmi_info {
> +

Please no empty line here.

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

One-line struct member kerneldoc works, but you need to prefix it with /**
like any other kernel-doc comment. See

https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#in-line-member-documentation-comments

Cheers, Daniel

>  	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

RE: [PATCH v2] drm: Add description for scdc variable

[Sharma, Shashank]

Thanks, V5 will do the trick for sure :-)

Regards
Shashank
-----Original Message-----
From: Daniel Vetter [mailto:daniel.vetter@ffwll.ch] On Behalf Of Daniel Vetter
Sent: Saturday, March 25, 2017 11:30 PM
To: Sharma, Shashank <shashank.sharma@intel.com>
Cc: dri-devel@lists.freedesktop.org; Daniel Vetter <daniel@ffwll.ch>
Subject: Re: [PATCH v2] drm: Add description for scdc variable

On Sat, Mar 25, 2017 at 11:21:29AM +0200, 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
> 
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Signed-off-by: Shashank Sharma <shashank.sharma@intel.com>

Since you're bikeshedding this to v4 already, might as well jump in too
:-)
> ---
>  include/drm/drm_connector.h | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h 
> index f8b766d..9fba967 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -133,6 +133,8 @@ struct drm_scdc {
>   * This information is available in CEA-861-F extension blocks (like HF-VSDB).
>   */
>  struct drm_hdmi_info {
> +

Please no empty line here.

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

One-line struct member kerneldoc works, but you need to prefix it with /** like any other kernel-doc comment. See

https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#in-line-member-documentation-comments

Cheers, Daniel

>  	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

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

[Daniel Vetter]

On Sun, Mar 26, 2017 at 08:39:51AM +0000, Sharma, Shashank wrote:
> Thanks, V5 will do the trick for sure :-)

Hm, where is v5?
-Daniel

> 
> Regards
> Shashank
> -----Original Message-----
> From: Daniel Vetter [mailto:daniel.vetter@ffwll.ch] On Behalf Of Daniel Vetter
> Sent: Saturday, March 25, 2017 11:30 PM
> To: Sharma, Shashank <shashank.sharma@intel.com>
> Cc: dri-devel@lists.freedesktop.org; Daniel Vetter <daniel@ffwll.ch>
> Subject: Re: [PATCH v2] drm: Add description for scdc variable
> 
> On Sat, Mar 25, 2017 at 11:21:29AM +0200, 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
> > 
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > Signed-off-by: Shashank Sharma <shashank.sharma@intel.com>
> 
> Since you're bikeshedding this to v4 already, might as well jump in too
> :-)
> > ---
> >  include/drm/drm_connector.h | 2 ++
> >  1 file changed, 2 insertions(+)
> > 
> > diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h 
> > index f8b766d..9fba967 100644
> > --- a/include/drm/drm_connector.h
> > +++ b/include/drm/drm_connector.h
> > @@ -133,6 +133,8 @@ struct drm_scdc {
> >   * This information is available in CEA-861-F extension blocks (like HF-VSDB).
> >   */
> >  struct drm_hdmi_info {
> > +
> 
> Please no empty line here.
> 
> > +	/* @scdc: sink's scdc support and capabilities */
> 
> One-line struct member kerneldoc works, but you need to prefix it with /** like any other kernel-doc comment. See
> 
> https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#in-line-member-documentation-comments
> 
> Cheers, Daniel
> 
> >  	struct drm_scdc scdc;
> >  };
> >  
> > --
> > 2.7.4
> > 
> 
> -- 
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch

-- 
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

RE: [PATCH v2] drm: Add description for scdc variable

[Sharma, Shashank]

Here you go, https://patchwork.freedesktop.org/patch/146746/ 
Had to remove extra line in start, from V4. 
Confirmed with a make DOCBOOKS="" htmldocs, no more error for scdc. 

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

On Sun, Mar 26, 2017 at 08:39:51AM +0000, Sharma, Shashank wrote:
> Thanks, V5 will do the trick for sure :-)

Hm, where is v5?
-Daniel

> 
> Regards
> Shashank
> -----Original Message-----
> From: Daniel Vetter [mailto:daniel.vetter@ffwll.ch] On Behalf Of 
> Daniel Vetter
> Sent: Saturday, March 25, 2017 11:30 PM
> To: Sharma, Shashank <shashank.sharma@intel.com>
> Cc: dri-devel@lists.freedesktop.org; Daniel Vetter <daniel@ffwll.ch>
> Subject: Re: [PATCH v2] drm: Add description for scdc variable
> 
> On Sat, Mar 25, 2017 at 11:21:29AM +0200, 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
> > 
> > Cc: Daniel Vetter <daniel@ffwll.ch>
> > Signed-off-by: Shashank Sharma <shashank.sharma@intel.com>
> 
> Since you're bikeshedding this to v4 already, might as well jump in 
> too
> :-)
> > ---
> >  include/drm/drm_connector.h | 2 ++
> >  1 file changed, 2 insertions(+)
> > 
> > diff --git a/include/drm/drm_connector.h 
> > b/include/drm/drm_connector.h index f8b766d..9fba967 100644
> > --- a/include/drm/drm_connector.h
> > +++ b/include/drm/drm_connector.h
> > @@ -133,6 +133,8 @@ struct drm_scdc {
> >   * This information is available in CEA-861-F extension blocks (like HF-VSDB).
> >   */
> >  struct drm_hdmi_info {
> > +
> 
> Please no empty line here.
> 
> > +	/* @scdc: sink's scdc support and capabilities */
> 
> One-line struct member kerneldoc works, but you need to prefix it with 
> /** like any other kernel-doc comment. See
> 
> https://dri.freedesktop.org/docs/drm/doc-guide/kernel-doc.html#in-line
> -member-documentation-comments
> 
> Cheers, Daniel
> 
> >  	struct drm_scdc scdc;
> >  };
> >  
> > --
> > 2.7.4
> > 
> 
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch

--
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