[PATCH RESEND] drm/tegra: dp: fix kernel-doc warnings in dp.h

[PATCH RESEND] drm/tegra: dp: fix kernel-doc warnings in dp.h

[Randy Dunlap]

Use correct kernel-doc format and add missing nested struct entries to
eliminate kernel-doc warnings:

Warning: drivers/gpu/drm/tegra/dp.h:28 Incorrect use of kernel-doc format:
 * tps3_supported:
Warning: drivers/gpu/drm/tegra/dp.h:54 struct member 'tps3_supported'
 not described in 'drm_dp_link_caps'
dp.h:73: warning: Function parameter or struct member 'apply_training'
 not described in 'drm_dp_link_ops'
dp.h:73: warning: Function parameter or struct member 'configure'
 not described in 'drm_dp_link_ops'
dp.h:160: warning: Excess struct member 'cr' description in 'drm_dp_link'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Thierry Reding <thierry.reding@gmail.com>
Cc: Mikko Perttunen <mperttunen@nvidia.com>
Cc: linux-tegra@vger.kernel.org
Cc: Jonathan Hunter <jonathanh@nvidia.com>
Cc: David Airlie <airlied@gmail.com>
Cc: Simona Vetter <simona@ffwll.ch>
---
 drivers/gpu/drm/tegra/dp.h |   12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

--- linux-next-20260218.orig/drivers/gpu/drm/tegra/dp.h
+++ linux-next-20260218/drivers/gpu/drm/tegra/dp.h
@@ -26,7 +26,7 @@ struct drm_dp_link_caps {
 	bool enhanced_framing;
 
 	/**
-	 * tps3_supported:
+	 * @tps3_supported:
 	 *
 	 * training pattern sequence 3 supported for equalization
 	 */
@@ -62,12 +62,12 @@ void drm_dp_link_caps_copy(struct drm_dp
  */
 struct drm_dp_link_ops {
 	/**
-	 * @apply_training:
+	 * @apply_training: apply the link training
 	 */
 	int (*apply_training)(struct drm_dp_link *link);
 
 	/**
-	 * @configure:
+	 * @configure: configure the DP link
 	 */
 	int (*configure)(struct drm_dp_link *link);
 };
@@ -113,6 +113,8 @@ struct drm_dp_link_train {
  * @max_lanes: maximum number of lanes supported on the link
  * @caps: capabilities supported on the link (see &drm_dp_link_caps)
  * @aux_rd_interval: AUX read interval to use for training (in microseconds)
+ * @aux_rd_interval.cr: clock recovery read interval
+ * @aux_rd_interval.ce: channel equalization read interval
  * @edp: eDP revision (0x11: eDP 1.1, 0x12: eDP 1.2, ...)
  * @rate: currently configured link rate
  * @lanes: currently configured number of lanes
@@ -126,10 +128,6 @@ struct drm_dp_link {
 
 	struct drm_dp_link_caps caps;
 
-	/**
-	 * @cr: clock recovery read interval
-	 * @ce: channel equalization read interval
-	 */
 	struct {
 		unsigned int cr;
 		unsigned int ce;

Claude review: drm/tegra: dp: fix kernel-doc warnings in dp.h

[Claude Code Review Bot]

Overall Series Review

Subject: drm/tegra: dp: fix kernel-doc warnings in dp.h
Author: Randy Dunlap <rdunlap@infradead.org>
Patches: 1
Reviewed: 2026-02-23T06:19:10.410561

---

This is a single-patch series that fixes kernel-doc warnings in `drivers/gpu/drm/tegra/dp.h`. The changes are purely documentation formatting fixes with no functional impact. The patch addresses four distinct kernel-doc issues: a missing `@` prefix, two missing short descriptions, and incorrectly placed nested struct member documentation.

All four fixes are correct and follow standard kernel-doc conventions. No correctness, locking, resource management, or UAPI concerns apply since the patch modifies only comments.

---
Generated by Claude Code Patch Reviewer

Claude review: drm/tegra: dp: fix kernel-doc warnings in dp.h

[Claude Code Review Bot]

Patch Review

Four changes, all correct:

**1. Missing `@` prefix on `tps3_supported`:**

> ```
> -	 * tps3_supported:
> +	 * @tps3_supported:
> ```

Straightforward fix. All other members in `struct drm_dp_link_caps` already use the `@` prefix; this one was simply missing it.

**2-3. Empty short descriptions for `apply_training` and `configure`:**

> ```
> -	 * @apply_training:
> +	 * @apply_training: apply the link training
> ```

> ```
> -	 * @configure:
> +	 * @configure: configure the DP link
> ```

kernel-doc warns when a member tag has no description text after the colon. Adding short descriptions resolves the warnings. The descriptions are terse but adequate for self-explanatory callback names.

**4. Moving nested struct member docs to the parent struct's kernel-doc block:**

> ```
> + * @aux_rd_interval.cr: clock recovery read interval
> + * @aux_rd_interval.ce: channel equalization read interval
> ```

> ```
> -	/**
> -	 * @cr: clock recovery read interval
> -	 * @ce: channel equalization read interval
> -	 */
>  	struct {
>  		unsigned int cr;
>  		unsigned int ce;
> ```

The old placement used `@cr` and `@ce` as if they were top-level members of `struct drm_dp_link`, which kernel-doc doesn't understand for anonymous nested structs -- it produced an "Excess struct member 'cr'" warning. Moving them to the parent struct's doc block with the `@aux_rd_interval.cr` / `@aux_rd_interval.ce` dotted notation is the correct kernel-doc approach for documenting anonymous nested struct members.

No issues found. The patch is correct and ready to apply.

---
Generated by Claude Code Patch Reviewer