linux/drivers/crypto/nx
Aditya Srivastava 10cb823bba crypto: nx - fix incorrect kernel-doc comment syntax in files
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
There are certain files in drivers/crypto/nx, which follow this syntax,
but the content inside does not comply with kernel-doc.
Such lines were probably not meant for kernel-doc parsing, but are parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc.

E.g., presence of kernel-doc like comment in the header lines for
drivers/crypto/nx/nx-sha256.c at header causes these warnings:
"warning: Function parameter or member 'tfm' not described in 'nx_crypto_ctx_sha256_init'"
"warning: expecting prototype for SHA(). Prototype was for nx_crypto_ctx_sha256_init() instead"

Similarly for other files too.

Provide a simple fix by replacing such occurrences with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.

Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
2021-03-26 20:15:58 +11:00
..
Kconfig treewide: Add SPDX license identifier - Makefile/Kconfig 2019-05-21 10:50:46 +02:00
Makefile crypto/nx: Rename nx-842-powernv file name to nx-common-powernv 2020-04-20 16:53:14 +10:00
nx_csbcpb.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
nx_debugfs.c crypto: nx - Repair some kernel-doc problems 2021-03-26 20:02:36 +11:00
nx-842-pseries.c locking/atomic, crypto/nx: Remove redundant casts 2019-06-03 12:32:57 +02:00
nx-842.c treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 157 2019-05-30 11:26:37 -07:00
nx-842.h License cleanup: add SPDX GPL-2.0 license identifier to files with no license 2017-11-02 11:10:55 +01:00
nx-aes-cbc.c crypto: nx - Repair some kernel-doc problems 2021-03-26 20:02:36 +11:00
nx-aes-ccm.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx-aes-ctr.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx-aes-ecb.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx-aes-gcm.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx-aes-xcbc.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx-common-powernv.c crypto: nx - add missing call to of_node_put() 2021-03-07 15:13:18 +11:00
nx-sha256.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx-sha512.c crypto: nx - fix incorrect kernel-doc comment syntax in files 2021-03-26 20:15:58 +11:00
nx.c crypto: nx - Repair some kernel-doc problems 2021-03-26 20:02:36 +11:00
nx.h crypto: Replace zero-length array with flexible-array member 2020-03-06 12:28:21 +11:00