[PATCH net-next 06/27] docs: Fix kernel-doc error in CAN driver
From: Marc Kleine-Budde <mkl@pengutronix.de>
Date: 2025-07-25 16:13:38
Also in:
linux-can
Subsystem:
can network drivers, ctu can fd driver, the rest · Maintainers:
Marc Kleine-Budde, Vincent Mailhol, Pavel Pisa, Ondrej Ille, Linus Torvalds
From: Luis Felipe Hernandez <redacted> 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 <redacted> Reviewed-by: Randy Dunlap <redacted> Tested-by: Randy Dunlap <redacted> Reviewed-by: Vincent Mailhol <redacted> Reviewed-by: Pavel Pisa <redacted> 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 | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/drivers/net/can/ctucanfd/ctucanfd_base.c b/drivers/net/can/ctucanfd/ctucanfd_base.c
index bf6398772960..8bd3f0fc385c 100644
--- a/drivers/net/can/ctucanfd/ctucanfd_base.c
+++ b/drivers/net/can/ctucanfd/ctucanfd_base.c@@ -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)
--
2.47.2