lib: packing: remove kernel-doc from header file

It is not necessary to have the kernel-doc duplicated both in the
header and in the implementation. It is better to have it near the
implementation of the function, since in C, a function can have N
declarations, but only one definition.

Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>
Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Link: https://patch.msgid.link/20241002-packing-kunit-tests-and-split-pack-unpack-v2-3-8373e551eae3@intel.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

diff --git a/include/linux/packing.h b/include/linux/packing.h
index 8d6571feb95de84ef4b0472e16c4bdfede15c3a6..69baefebcd0205c37b4b3f9c8fe7d03c1bb4e94c 100644 (file)
--- a/include/linux/packing.h
+++ b/include/linux/packing.h
@@ -17,32 +17,6 @@ enum packing_op {
        UNPACK,
 };
 
-/**
- * packing - Convert numbers (currently u64) between a packed and an unpacked
- *          format. Unpacked means laid out in memory in the CPU's native
- *          understanding of integers, while packed means anything else that
- *          requires translation.
- *
- * @pbuf: Pointer to a buffer holding the packed value.
- * @uval: Pointer to an u64 holding the unpacked value.
- * @startbit: The index (in logical notation, compensated for quirks) where
- *           the packed value starts within pbuf. Must be larger than, or
- *           equal to, endbit.
- * @endbit: The index (in logical notation, compensated for quirks) where
- *         the packed value ends within pbuf. Must be smaller than, or equal
- *         to, startbit.
- * @op: If PACK, then uval will be treated as const pointer and copied (packed)
- *     into pbuf, between startbit and endbit.
- *     If UNPACK, then pbuf will be treated as const pointer and the logical
- *     value between startbit and endbit will be copied (unpacked) to uval.
- * @quirks: A bit mask of QUIRK_LITTLE_ENDIAN, QUIRK_LSW32_IS_FIRST and
- *         QUIRK_MSB_ON_THE_RIGHT.
- *
- * Return: 0 on success, EINVAL or ERANGE if called incorrectly. Assuming
- *        correct usage, return code may be discarded.
- *        If op is PACK, pbuf is modified.
- *        If op is UNPACK, uval is modified.
- */
 int packing(void *pbuf, u64 *uval, int startbit, int endbit, size_t pbuflen,
            enum packing_op op, u8 quirks);