[PATCH] drm: Add description for scdc variable

[PATCH] 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'"

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 0fcea02..eafda3e 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;
 	u8 ycbcr420_dc_modes;
 	u64 ycbcr420_vcb_map;
-- 
2.7.4

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

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

[Jani Nikula]

On Sat, 25 Mar 2017, Shashank Sharma <shashank.sharma@intel.com> 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'"

Did you actually run 'make htmldocs' with this? The opening marker for
kernel-doc comments is "/**".

BR,
Jani.

>
> 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 0fcea02..eafda3e 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;
>  	u8 ycbcr420_dc_modes;
>  	u64 ycbcr420_vcb_map;

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

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

[Jani Nikula]

On Mon, 27 Mar 2017, Jani Nikula <jani.nikula@linux.intel.com> wrote:
> On Sat, 25 Mar 2017, Shashank Sharma <shashank.sharma@intel.com> 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'"
>
> Did you actually run 'make htmldocs' with this? The opening marker for
> kernel-doc comments is "/**".

Nevermind, I'm just lagging in my email...

>
> BR,
> Jani.
>
>>
>> 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 0fcea02..eafda3e 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;
>>  	u8 ycbcr420_dc_modes;
>>  	u64 ycbcr420_vcb_map;

-- 
Jani Nikula, Intel Open Source Technology Center
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel