Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: Fix kernel-doc error in CAN driver

Fix kernel-doc formatting issue causing unexpected indentation error
in ctucanfd driver documentation build. Convert main return values
to bullet list format while preserving numbered sub-list in order to
correct indentation error and visual structure in rendered html.

Signed-off-by: Luis Felipe Hernandez <luis.hernandez093@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Reviewed-by: Pavel Pisa <pisa@fel.cvut.cz>
Link: https://patch.msgid.link/20250722035352.21807-1-luis.hernandez093@gmail.com
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>

authored by

Luis Felipe Hernandez and committed by
Marc Kleine-Budde
2db7a52c b7d012e5

+6 -5
+6 -5
drivers/net/can/ctucanfd/ctucanfd_base.c
··· 506 506 * @buf: TXT Buffer index to which frame is inserted (0-based) 507 507 * @isfdf: True - CAN FD Frame, False - CAN 2.0 Frame 508 508 * 509 - * Return: True - Frame inserted successfully 510 - * False - Frame was not inserted due to one of: 511 - * 1. TXT Buffer is not writable (it is in wrong state) 512 - * 2. Invalid TXT buffer index 513 - * 3. Invalid frame length 509 + * Return: 510 + * * True - Frame inserted successfully 511 + * * False - Frame was not inserted due to one of: 512 + * 1. TXT Buffer is not writable (it is in wrong state) 513 + * 2. Invalid TXT buffer index 514 + * 3. Invalid frame length 514 515 */ 515 516 static bool ctucan_insert_frame(struct ctucan_priv *priv, const struct canfd_frame *cf, u8 buf, 516 517 bool isfdf)