[PATCH 2/2] lib/842: Fix kernel-doc warnings for sw842_decompress()

From: Sunday Adelodun

Date: Thu Nov 13 2025 - 11:53:51 EST


The following warnings were reported:
Warning: lib/842/842_decompress.c:278 function parameter ]
'in' not described
Warning: lib/842/842_decompress.c:278 function parameter
'ilen' not described
Warning: lib/842/842_decompress.c:278 function parameter
'out' not described
Warning: lib/842/842_decompress.c:278 function parameter
'olen' not described

Fix kernel-doc warnings in sw842_decompress() caused by missing short
description and undocumented parameters.

Signed-off-by: Sunday Adelodun <adelodunolaoluwa@xxxxxxxxx>
---
lib/842/842_decompress.c | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/lib/842/842_decompress.c b/lib/842/842_decompress.c
index 582085ef8b49..465e2dda6a25 100644
--- a/lib/842/842_decompress.c
+++ b/lib/842/842_decompress.c
@@ -260,10 +260,13 @@ static int do_op(struct sw842_param *p, u8 o)
}

/**
- * sw842_decompress
+ * sw842_decompress - Decompress the 842-compressed buffer
*
- * Decompress the 842-compressed buffer of length @ilen at @in
- * to the output buffer @out, using no more than @olen bytes.
+ * @in: Pointer to the input buffer containing 842-compressed data.
+ * @ilen: Length (in bytes) of the input buffer.
+ * @out: Pointer to the output buffer where decompressed data will be
+ * written.
+ * @olen: Pointer to a variable holding the maximum output length.
*
* The compressed buffer must be only a single 842-compressed buffer,
* with the standard format described in the comments in 842.h
--
2.43.0