linux-kernel - [PATCH 2/2] lib/842: Fix kernel-doc warnings for sw842

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20251113164019.48840-2-adelodunolaoluwa@yahoo.com>
Date: Thu, 13 Nov 2025 17:40:19 +0100
From: Sunday Adelodun <adelodunolaoluwa@...oo.com>
To: haren@...ibm.com
Cc: linux-kernel@...r.kernel.org,
	skhan@...uxfoundation.org,
	david.hunter.linux@...il.com,
	linux-kernel-mentees@...ts.linuxfoundation.org,
	Sunday Adelodun <adelodunolaoluwa@...oo.com>
Subject: [PATCH 2/2] lib/842: Fix kernel-doc warnings for sw842_decompress()

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@...oo.com>
---
 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