crypto: amcc - fix incorrect kernel-doc comment syntax in files
authorAditya Srivastava <yashsri421@gmail.com>
Sun, 21 Mar 2021 12:08:32 +0000 (17:38 +0530)
committerHerbert Xu <herbert@gondor.apana.org.au>
Fri, 26 Mar 2021 09:15:58 +0000 (20:15 +1100)
commit73f04d3d800f3c8058bb00447e3e1c4cdc85a2b0
tree6e8ed0f53b5c5a920995bed4e9e4d42c552b7aee
parentdbb153c02bacecfbc695738bf7fec4becd46bc39
crypto: amcc - 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/amcc, 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
drivers/crypto/amcc/crypto4xx_alg.c at header, and some other lines,
causes these warnings by kernel-doc:

"warning: expecting prototype for AMCC SoC PPC4xx Crypto Driver(). Prototype was for set_dynamic_sa_command_0() instead"
"warning: Function parameter or member 'dir' not described in 'set_dynamic_sa_command_0'"
etc..

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>
drivers/crypto/amcc/crypto4xx_alg.c
drivers/crypto/amcc/crypto4xx_core.c
drivers/crypto/amcc/crypto4xx_core.h
drivers/crypto/amcc/crypto4xx_reg_def.h
drivers/crypto/amcc/crypto4xx_sa.h
drivers/crypto/amcc/crypto4xx_trng.h