superrob1500
/
mirror-linux
mirror of https://github.com/torvalds/linux
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

crypto: add missing kernel-doc for anonymous union members 

Document the anonymous SKCIPHER_ALG_COMMON and COMP_ALG_COMMON struct
members in skcipher_alg, scomp_alg, and acomp_alg, following the
existing pattern used by HASH_ALG_COMMON in shash_alg.

This fixes the following kernel-doc warnings:

  include/crypto/skcipher.h:166: struct member 'SKCIPHER_ALG_COMMON' not described in 'skcipher_alg'
  include/crypto/internal/scompress.h:39: struct member 'COMP_ALG_COMMON' not described in 'scomp_alg'
  include/crypto/internal/acompress.h:55: struct member 'COMP_ALG_COMMON' not described in 'acomp_alg'

Signed-off-by: Kit Dallege <xaum.io@gmail.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
master
Kit Dallege 2026-03-15 15:57:22 +01:00 committed by Herbert Xu
parent 7c622c4fa8
commit f9bbd547cf
3 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/crypto/internal/acompress.h
View File

@ -42,6 +42,7 @@
* *
* @base: Common crypto API algorithm data structure * @base: Common crypto API algorithm data structure
* @calg: Cmonn algorithm data structure shared with scomp * @calg: Cmonn algorithm data structure shared with scomp
* @COMP_ALG_COMMON: see struct comp_alg_common
*/ */
struct acomp_alg { struct acomp_alg {
int (*compress)(struct acomp_req *req); int (*compress)(struct acomp_req *req);

1
include/crypto/internal/scompress.h
View File

@ -22,6 +22,7 @@ struct crypto_scomp {
* @decompress: Function performs a de-compress operation * @decompress: Function performs a de-compress operation
* @streams: Per-cpu memory for algorithm * @streams: Per-cpu memory for algorithm
* @calg: Cmonn algorithm data structure shared with acomp * @calg: Cmonn algorithm data structure shared with acomp
* @COMP_ALG_COMMON: see struct comp_alg_common
*/ */
struct scomp_alg { struct scomp_alg {
int (*compress)(struct crypto_scomp *tfm, const u8 *src, int (*compress)(struct crypto_scomp *tfm, const u8 *src,

1
include/crypto/skcipher.h
View File

@ -145,6 +145,7 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
* considerably more efficient if it can operate on multiple chunks * considerably more efficient if it can operate on multiple chunks
* in parallel. Should be a multiple of chunksize. * in parallel. Should be a multiple of chunksize.
* @co: see struct skcipher_alg_common * @co: see struct skcipher_alg_common
* @SKCIPHER_ALG_COMMON: see struct skcipher_alg_common
* *
* All fields except @ivsize are mandatory and must be filled. * All fields except @ivsize are mandatory and must be filled.
*/ */