crypto: ux500 - fix incorrect kernel-doc comment syntax
authorAditya Srivastava <yashsri421@gmail.com>
Sun, 21 Mar 2021 12:09:12 +0000 (17:39 +0530)
committerHerbert Xu <herbert@gondor.apana.org.au>
Fri, 26 Mar 2021 09:15:58 +0000 (20:15 +1100)
commitce668da5f11e3aeed49843980b70529aa61f4275
tree31633acf5b1fd71a1d3c1109b1816ce05512d0b4
parent73f04d3d800f3c8058bb00447e3e1c4cdc85a2b0
crypto: ux500 - fix incorrect kernel-doc comment syntax

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
There are certain files in drivers/crypto/ux500, 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/ux500/cryp/cryp.h at header causes this warning:

"warning: expecting prototype for ST(). Prototype was for _CRYP_H_() 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>
drivers/crypto/ux500/cryp/cryp.h
drivers/crypto/ux500/cryp/cryp_irq.h
drivers/crypto/ux500/cryp/cryp_irqp.h
drivers/crypto/ux500/cryp/cryp_p.h