[PATCH linux-next] drm: Fix for kernel doc warning

R Sundar posted 1 patch 1 month, 3 weeks ago
include/drm/drm_drv.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH linux-next] drm: Fix for kernel doc warning
Posted by R Sundar 1 month, 3 weeks ago
Added colon in kernel-doc comment to fix the warning.

./include/drm/drm_drv.h:372: warning: Incorrect use of kernel-doc format:          * @fbdev_probe
./include/drm/drm_drv.h:435: warning: Function parameter or struct member 'fbdev_probe' not described in 'drm_driver'

Signed-off-by: R Sundar <prosunofficial@gmail.com>
---
 include/drm/drm_drv.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/drm/drm_drv.h b/include/drm/drm_drv.h
index 36a606af4ba1..1bbbcb8e2d23 100644
--- a/include/drm/drm_drv.h
+++ b/include/drm/drm_drv.h
@@ -369,7 +369,7 @@ struct drm_driver {
 			       uint64_t *offset);
 
 	/**
-	 * @fbdev_probe
+	 * @fbdev_probe:
 	 *
 	 * Allocates and initialize the fb_info structure for fbdev emulation.
 	 * Furthermore it also needs to allocate the DRM framebuffer used to
-- 
2.34.1
Re: [PATCH linux-next] drm: Fix for kernel doc warning
Posted by Jani Nikula 1 month, 2 weeks ago
On Thu, 03 Oct 2024, R Sundar <prosunofficial@gmail.com> wrote:
> Added colon in kernel-doc comment to fix the warning.
>
> ./include/drm/drm_drv.h:372: warning: Incorrect use of kernel-doc format:          * @fbdev_probe
> ./include/drm/drm_drv.h:435: warning: Function parameter or struct member 'fbdev_probe' not described in 'drm_driver'
>
> Signed-off-by: R Sundar <prosunofficial@gmail.com>

Pushed to drm-misc-next, thanks for the patch.

BR,
Jani.

> ---
>  include/drm/drm_drv.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/drm/drm_drv.h b/include/drm/drm_drv.h
> index 36a606af4ba1..1bbbcb8e2d23 100644
> --- a/include/drm/drm_drv.h
> +++ b/include/drm/drm_drv.h
> @@ -369,7 +369,7 @@ struct drm_driver {
>  			       uint64_t *offset);
>  
>  	/**
> -	 * @fbdev_probe
> +	 * @fbdev_probe:
>  	 *
>  	 * Allocates and initialize the fb_info structure for fbdev emulation.
>  	 * Furthermore it also needs to allocate the DRM framebuffer used to

-- 
Jani Nikula, Intel