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

[PATCH v2] 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>
Acked-by: Mikko Perttunen <mperttunen@nvidia.com>
---
v2: rebase & resend

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-20260427.orig/drivers/gpu/drm/tegra/dp.h
+++ linux-next-20260427/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-04-28T14:01:51.088204

---

This is a single, straightforward kernel-doc fix patch (v2, rebased) for `drivers/gpu/drm/tegra/dp.h`. It addresses four kernel-doc warnings by correcting documentation formatting. The patch is correct, minimal, and already carries an Acked-by from the Tegra maintainer (Mikko Perttunen). No functional code changes are involved.

**Verdict: Looks good. No issues found.**

---
Generated by Claude Code Patch Reviewer

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

[Claude Code Review Bot]

Patch Review

**Status: Clean**

The patch fixes four distinct kernel-doc issues:

1. **Missing `@` prefix on `tps3_supported`** (line 103 of the diff):
   ```c
   - * tps3_supported:
   + * @tps3_supported:
   ```
   Correct — kernel-doc requires `@` prefix for struct member documentation.

2. **Empty descriptions for `@apply_training` and `@configure`** (lines 113, 119 of the diff):
   ```c
   - * @apply_training:
   + * @apply_training: apply the link training
   ```
   ```c
   - * @configure:
   + * @configure: configure the DP link
   ```
   Correct — kernel-doc warns when `@member:` entries in a struct/ops doc block have no description text. The added descriptions are brief and appropriate.

3. **Misplaced nested struct member docs for `aux_rd_interval`** (lines 126–141 of the diff):
   The old code had `@cr` and `@ce` documented in a separate `/** */` block directly above the anonymous struct, which kernel-doc doesn't associate with the parent struct's doc block. The fix removes that orphaned comment and instead documents `aux_rd_interval.cr` and `aux_rd_interval.ce` as nested member entries in the parent `struct drm_dp_link` doc block:
   ```c
   + * @aux_rd_interval.cr: clock recovery read interval
   + * @aux_rd_interval.ce: channel equalization read interval
   ```
   This is the correct kernel-doc syntax for anonymous nested struct members, and eliminates both the "Excess struct member 'cr'" warning and the implicit missing-member warnings.

All four fixes are correct kernel-doc usage. The patch is well-scoped — it changes only documentation, no functional code. The commit message clearly lists all four warnings being fixed. The Acked-by from Mikko Perttunen is appropriate as the Tegra driver maintainer.

No concerns with this patch.

---
Generated by Claude Code Patch Reviewer