drm: fix parameters documentation style
Subsystems (2)
PATCH 1/1 drm: fix parameters documentation style
Remove old documentation style and use new one to avoid warnings when compiling with W=1
Signed-off-by Benjamin Gaignard <[email protected]>
--- drivers/gpu/drm/drm_dma.c | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-)
drivers/gpu/drm/drm_dma.c +11 -10
@@ -42,10 +42,10 @@#include "drm_legacy.h" /** -* Initialize the DMA data. +* drm_legacy_dma_setup() - Initialize the DMA data. * -* \param dev DRM device. -* \return zero on success or a negative value on failure. +* @dev: DRM device. +* return zero on success or a negative value on failure. * * Allocate and initialize a drm_device_dma structure. */
@@ -71,9 +71,9 @@ int drm_legacy_dma_setup(struct drm_device *dev) }/** -* Cleanup the DMA resources. +* drm_legacy_dma_takedown() - Cleanup the DMA resources. * -* \param dev DRM device. +* @dev: DRM device. * * Free all pages associated with DMA buffers, the buffers and pages lists, and * finally the drm_device::dma structure itself.
@@ -120,10 +120,10 @@ void drm_legacy_dma_takedown(struct drm_device *dev) }/** -* Free a buffer. +* drm_legacy_free_buffer() - Free a buffer. * -* \param dev DRM device. -* \param buf buffer to free. +* @dev: DRM device. +* @buf: buffer to free. * * Resets the fields of \p buf. */
@@ -139,9 +139,10 @@ void drm_legacy_free_buffer(struct drm_device *dev, struct drm_buf * buf) }/** -* Reclaim the buffers. +* drm_legacy_reclaim_buffers() - Reclaim the buffers. * -* \param file_priv DRM file private. +* @dev: DRM device. +* @file_priv: DRM file private. * * Frees each buffer associated with \p file_priv not already on the hardware. */
Signature · 1 line
2.15.0
Hi,
This all looks good except one item: (see below)
Quoted 13 lines · Benjamin Gaignard
Remove old documentation style and use new one to avoid warnings when compiling with W=1
Signed-off-by Benjamin Gaignard <[email protected]>--- drivers/gpu/drm/drm_dma.c | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-)drivers/gpu/drm/drm_dma.c +0
-0
drivers/gpu/drm/drm_dma.c line 48
Quoted 10 lines
drivers/gpu/drm/drm_dma.c +3
-3@@ -42,10 +42,10 @@#include "drm_legacy.h" /** -* Initialize the DMA data. +* drm_legacy_dma_setup() - Initialize the DMA data. * -* \param dev DRM device. -* \return zero on success or a negative value on failure. +* @dev: DRM device. +* return zero on success or a negative value on failure.
* Return: zero on success or a negative value on failure.
Quoted 33 lines
drivers/gpu/drm/drm_dma.c +5
-5* * Allocate and initialize a drm_device_dma structure. */ @@ -71,9 +71,9 @@ int drm_legacy_dma_setup(struct drm_device *dev) }/** -* Cleanup the DMA resources. +* drm_legacy_dma_takedown() - Cleanup the DMA resources. * -* \param dev DRM device. +* @dev: DRM device. * * Free all pages associated with DMA buffers, the buffers and pages lists, and * finally the drm_device::dma structure itself. @@ -120,10 +120,10 @@ void drm_legacy_dma_takedown(struct drm_device *dev) }/** -* Free a buffer. +* drm_legacy_free_buffer() - Free a buffer. * -* \param dev DRM device. -* \param buf buffer to free. +* @dev: DRM device. +* @buf: buffer to free. * * Resets the fields of \p buf. */ @@ -139,9 +139,10 @@ void drm_legacy_free_buffer(struct drm_device *dev, struct drm_buf * buf) }
drivers/gpu/drm/drm_dma.c void drm_legacy_free_buffer(struct drm_device *dev, struct drm_buf * buf) · line 148
Quoted 10 lines
drivers/gpu/drm/drm_dma.c +3
-2/** -* Reclaim the buffers. +* drm_legacy_reclaim_buffers() - Reclaim the buffers. * -* \param file_priv DRM file private. +* @dev: DRM device. +* @file_priv: DRM file private. * * Frees each buffer associated with \p file_priv not already on the hardware. */
thanks.
Signature · 1 line
~Randy