Re: [PATCH] crypto: ccp.h - repair all kernel-doc comments

[Herbert Xu]

On Tue, Sep 01, 2026 at 11:54:38AM -0700, Randy Dunlap wrote:
> Eliminate all kernel-doc warnings in <linux/ccp.h>:
> - add Returns: for function return values
> - use the enum keyword when describing an enum in kernel-doc
> - add missing enum value descriptions
> - add or repair missing struct member descriptions
> - use nested struct notation as needed
> 
> Warning: include/linux/ccp.h:30 No description found for return value
>  of 'ccp_present'
> Warning: include/linux/ccp.h:42 No description found for return value
>  of 'ccp_version'
> Warning: include/linux/ccp.h:67 No description found for return value
>  of 'ccp_enqueue_cmd'
> Warning: include/linux/ccp.h:97 cannot understand function prototype:
>  'enum ccp_aes_type'
> Warning: include/linux/ccp.h:114 cannot understand function prototype:
>  'enum ccp_aes_mode'
> Warning: include/linux/ccp.h:128 Enum value 'CCP_AES_MODE_GHASH' not
>  described in enum 'ccp_aes_mode'
> Warning: include/linux/ccp.h:128 Enum value 'CCP_AES_MODE_GCTR' not
>  described in enum 'ccp_aes_mode'
> Warning: include/linux/ccp.h:128 Enum value 'CCP_AES_MODE_GCM' not
>  described in enum 'ccp_aes_mode'
> Warning: include/linux/ccp.h:128 Enum value 'CCP_AES_MODE_GMAC' not
>  described in enum 'ccp_aes_mode'
> Warning: include/linux/ccp.h:134 cannot understand function prototype:
>  'enum ccp_aes_action'
> Warning: include/linux/ccp.h:190 struct member 'authsize' not described
>  in 'ccp_aes_engine'
> Warning: include/linux/ccp.h:190 struct member 'aad_len' not described
>  in 'ccp_aes_engine'
> Warning: include/linux/ccp.h:202 cannot understand function prototype:
>  'enum ccp_xts_aes_unit_size'
> Warning: include/linux/ccp.h:245 struct member 'type' not described in
>  'ccp_xts_aes_engine'
> Warning: include/linux/ccp.h:255 cannot understand function prototype:
>  'enum ccp_sha_type'
> Warning: include/linux/ccp.h:394 cannot understand function prototype:
>  'enum ccp_passthru_bitwise'
> Warning: include/linux/ccp.h:410 cannot understand function prototype:
>  'enum ccp_passthru_byteswap'
> Warning: include/linux/ccp.h:472 struct member 'src_dma' not described
>  in 'ccp_passthru_nomap_engine'
> Warning: include/linux/ccp.h:472 struct member 'dst_dma' not described
>  in 'ccp_passthru_nomap_engine'
> Warning: include/linux/ccp.h:472 Excess struct member 'src' description in
>  'ccp_passthru_nomap_engine' (did you mean one of: 'src_len', 'src_dma')
> Warning: include/linux/ccp.h:472 Excess struct member 'dst' description in
>  'ccp_passthru_nomap_engine' (did you mean one of: 'dst_dma')
> Warning: include/linux/ccp.h:489 cannot understand function prototype:
>  'enum ccp_ecc_function'
> Warning: include/linux/ccp.h:587 struct member 'u' not described in
>  'ccp_ecc_engine'
> Warning: include/linux/ccp.h:587 Excess struct member 'mm' description in
>  'ccp_ecc_engine' (did you mean one of: 'u.mm')
> Warning: include/linux/ccp.h:587 Excess struct member 'pm' description in
>  'ccp_ecc_engine' (did you mean one of: 'u.pm')
> Warning: include/linux/ccp.h:602 cannot understand function prototype:
>  'enum ccp_engine'
> 
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> Cc: Tom Lendacky <thomas.lendacky@xxxxxxx>
> Cc: John Allen <john.allen@xxxxxxx>
> Cc: Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>
> Cc: "David S. Miller" <davem@xxxxxxxxxxxxx>
> Cc: linux-crypto@xxxxxxxxxxxxxxx
> 
>  include/linux/ccp.h |   58 +++++++++++++++++++++++++++---------------
>  1 file changed, 38 insertions(+), 20 deletions(-)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt