drm/atomic-helper: fix kernel-doc problems
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 17 Jan 2023 07:02:16 +0000 (23:02 -0800)
committerMaxime Ripard <maxime@cerno.tech>
Thu, 19 Jan 2023 08:16:04 +0000 (09:16 +0100)
Fix a kernel-doc warning and other kernel-doc formatting for
drm_atomic_helper_connect_tv_check().

drivers/gpu/drm/drm_atomic_state_helper.c:560: warning: Cannot understand  * @drm_atomic_helper_connector_tv_check: Validate an analog TV connector state
 on line 560 - I thought it was a doc line

Fixes: 5a28cefda3a9 ("drm/atomic-helper: Add an analog TV atomic_check implementation")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Maxime Ripard <maxime@cerno.tech>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
CC: Thomas Zimmermann <tzimmermann@suse.de>
Cc: David Airlie <airlied@gmail.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Maxime Ripard <maxime@cerno.tech>
Link: https://patchwork.freedesktop.org/patch/msgid/20230117070216.30318-1-rdunlap@infradead.org
drivers/gpu/drm/drm_atomic_state_helper.c

index 22251c5f6a8aead8bb0f310d2c0a4e718e94d611..784e63d70a421ea0272e64e1abd5b4ee113b45dc 100644 (file)
@@ -557,15 +557,15 @@ void drm_atomic_helper_connector_tv_reset(struct drm_connector *connector)
 EXPORT_SYMBOL(drm_atomic_helper_connector_tv_reset);
 
 /**
- * @drm_atomic_helper_connector_tv_check: Validate an analog TV connector state
+ * drm_atomic_helper_connector_tv_check - Validate an analog TV connector state
  * @connector: DRM Connector
  * @state: the DRM State object
  *
  * Checks the state object to see if the requested state is valid for an
  * analog TV connector.
  *
- * Returns:
- * Zero for success, a negative error code on error.
+ * Return:
+ * %0 for success, a negative error code on error.
  */
 int drm_atomic_helper_connector_tv_check(struct drm_connector *connector,
                                         struct drm_atomic_state *state)