• Aditya Srivastava's avatar
    crypto: amcc - fix incorrect kernel-doc comment syntax in files · 73f04d3d
    Aditya Srivastava authored
    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: 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>
    73f04d3d
crypto4xx_sa.h 7.13 KB