thunderbolt: Update eeprom.c function documentation

aborzesz · westeri · commit 728ab0e4a0ca · 2025-09-17T07:32:59.000+02:00
Make eeprom.c function documentation compliant with current kernel-doc
standards. No functional changes.

Signed-off-by: Alan Borzeszkowski &lt;alan.borzeszkowski@linux.intel.com&gt;
Signed-off-by: Mika Westerberg &lt;mika.westerberg@linux.intel.com&gt;
diff --git a/drivers/thunderbolt/eeprom.c b/drivers/thunderbolt/eeprom.c
@@ -298,6 +298,8 @@ struct tb_drom_entry_desc {
  *
  * Does not use the cached copy in sw->drom. Used during resume to check switch
  * identity.
+ *
+ * Return: %0 on success, negative errno otherwise.
  */
 int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid)
 {
@@ -709,7 +711,7 @@ static int tb_drom_device_read(struct tb_switch *sw)
  * populates the fields in @sw accordingly. Can be called for any router
  * generation.
  *
- * Returns %0 in case of success and negative errno otherwise.
+ * Return: %0 on success, negative errno otherwise.
  */
 int tb_drom_read(struct tb_switch *sw)
 {

Original file line number	Diff line number	Diff line change
`@@ -298,6 +298,8 @@ struct tb_drom_entry_desc {`
`298`	`298`	`*`
`299`	`299`	`* Does not use the cached copy in sw->drom. Used during resume to check switch`
`300`	`300`	`* identity.`
	`301`	`+ *`
	`302`	`+ * Return: %0 on success, negative errno otherwise.`
`301`	`303`	`*/`
`302`	`304`	`int tb_drom_read_uid_only(struct tb_switch sw, u64 uid)`
`303`	`305`	`{`
`@@ -709,7 +711,7 @@ static int tb_drom_device_read(struct tb_switch *sw)`
`709`	`711`	`* populates the fields in @sw accordingly. Can be called for any router`
`710`	`712`	`* generation.`
`711`	`713`	`*`
`712`		`- * Returns %0 in case of success and negative errno otherwise.`
	`714`	`+ * Return: %0 on success, negative errno otherwise.`
`713`	`715`	`*/`
`714`	`716`	`int tb_drom_read(struct tb_switch *sw)`
`715`	`717`	`{`