| Message ID | 20230415104304.104134-3-krzysztof.kozlowski@linaro.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | [01/15] w1: ds2408: drop kerneldoc annotation | expand |
On 4/15/23 03:42, Krzysztof Kozlowski wrote: > 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. > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Thanks. > --- > drivers/w1/slaves/w1_ds28e04.c | 15 ++++++++------- > 1 file changed, 8 insertions(+), 7 deletions(-) > > diff --git a/drivers/w1/slaves/w1_ds28e04.c b/drivers/w1/slaves/w1_ds28e04.c > index 6cef6e2edb89..f54d6afd79c3 100644 > --- a/drivers/w1/slaves/w1_ds28e04.c > +++ b/drivers/w1/slaves/w1_ds28e04.c > @@ -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 @@ static ssize_t eeprom_read(struct file *filp, struct kobject *kobj, > } > > /** > - * 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) > {
diff --git a/drivers/w1/slaves/w1_ds28e04.c b/drivers/w1/slaves/w1_ds28e04.c index 6cef6e2edb89..f54d6afd79c3 100644 --- a/drivers/w1/slaves/w1_ds28e04.c +++ b/drivers/w1/slaves/w1_ds28e04.c @@ -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 @@ static ssize_t eeprom_read(struct file *filp, struct kobject *kobj, } /** - * 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) {
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. Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> --- drivers/w1/slaves/w1_ds28e04.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)