w1: ds28e04: correct kerneldoc annotation
authorKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Sat, 15 Apr 2023 10:42:51 +0000 (12:42 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 20 Apr 2023 12:15:06 +0000 (14:15 +0200)
Correct kerneldoc comments (or drop annotation) to fix:

  w1_ds28e04.c:57: warning: This comment starts with '/**', but isn't a kernel-doc comment.
  w1_ds28e04.c:149: warning: This comment starts with '/**', but isn't a kernel-doc comment.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20230415104304.104134-3-krzysztof.kozlowski@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/w1/slaves/w1_ds28e04.c

index 6cef6e2..f54d6af 100644 (file)
@@ -53,7 +53,7 @@ struct w1_f1C_data {
        u32     validcrc;
 };
 
-/**
+/*
  * Check the file size bounds and adjusts count as needed.
  * This would not be needed if the file size didn't reset to 0 after a write.
  */
@@ -146,16 +146,17 @@ out_up:
 }
 
 /**
- * Writes to the scratchpad and reads it back for verification.
+ * w1_f1C_write() - Writes to the scratchpad and reads it back for verification.
+ * @sl:                The slave structure
+ * @addr:      Address for the write
+ * @len:       length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
+ * @data:      The data to write
+ *
  * Then copies the scratchpad to EEPROM.
  * The data must be on one page.
  * The master must be locked.
  *
- * @param sl   The slave structure
- * @param addr Address for the write
- * @param len   length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
- * @param data The data to write
- * @return     0=Success -1=failure
+ * Return:     0=Success, -1=failure
  */
 static int w1_f1C_write(struct w1_slave *sl, int addr, int len, const u8 *data)
 {