[PATCH] kernel: Format kernel-doc comments

Sravan Kumar Gundu posted 1 patch 7 months, 1 week ago
kernel/panic.c | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
[PATCH] kernel: Format kernel-doc comments
Posted by Sravan Kumar Gundu 7 months, 1 week ago
kernel-doc function comment doesn't follows documentation commenting style
misinterpreting arguments description with function description

please see latest docs generated before applying this patch
https://docs.kernel.org/driver-api/basics.html#c.panic

Signed-off-by: Sravan Kumar Gundu <sravankumarlpu@gmail.com>
---
 kernel/panic.c | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

diff --git a/kernel/panic.c b/kernel/panic.c
index a3889f38153d..1f52922d1b2e 100644
--- a/kernel/panic.c
+++ b/kernel/panic.c
@@ -277,12 +277,10 @@ static void panic_other_cpus_shutdown(bool crash_kexec)
 }
 
 /**
- *	panic - halt the system
- *	@fmt: The text string to print
+ * panic - halt the system
+ * @fmt: The text string to print
  *
- *	Display a message, then perform cleanups.
- *
- *	This function never returns.
+ * Display a message, then perform cleanups. This function never returns.
  */
 void panic(const char *fmt, ...)
 {
-- 
2.43.0