• Aditya Srivastava's avatar
    crypto: nx - fix incorrect kernel-doc comment syntax in files · 10cb823b
    Aditya Srivastava authored
    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: default avatarAditya Srivastava <yashsri421@gmail.com>
    Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
    10cb823b
nx-sha256.c 7.46 KB