]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
docs: Fix kernel-doc error in CAN driver
authorLuis Felipe Hernandez <luis.hernandez093@gmail.com>
Tue, 22 Jul 2025 03:53:52 +0000 (23:53 -0400)
committerMarc Kleine-Budde <mkl@pengutronix.de>
Fri, 25 Jul 2025 11:09:07 +0000 (13:09 +0200)
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>
drivers/net/can/ctucanfd/ctucanfd_base.c

index bf6398772960a58295b80e29aeabd4bdd6e8333a..8bd3f0fc385c3096e21aca20244e4ce04cf5708c 100644 (file)
@@ -506,11 +506,12 @@ static bool ctucan_is_txt_buf_writable(struct ctucan_priv *priv, u8 buf)
  * @buf:       TXT Buffer index to which frame is inserted (0-based)
  * @isfdf:     True - CAN FD Frame, False - CAN 2.0 Frame
  *
- * Return: True - Frame inserted successfully
- *        False - Frame was not inserted due to one of:
- *                     1. TXT Buffer is not writable (it is in wrong state)
- *                     2. Invalid TXT buffer index
- *                     3. Invalid frame length
+ * Return:
+ * * True - Frame inserted successfully
+ * * False - Frame was not inserted due to one of:
+ *     1. TXT Buffer is not writable (it is in wrong state)
+ *     2. Invalid TXT buffer index
+ *     3. Invalid frame length
  */
 static bool ctucan_insert_frame(struct ctucan_priv *priv, const struct canfd_frame *cf, u8 buf,
                                bool isfdf)