[PATCH] crypto:skcipher: fix kernel-doc warning for anonymous union member

Abdellah Ouhbi posted 1 patch 3 weeks, 4 days ago
include/crypto/skcipher.h | 1 +
1 file changed, 1 insertion(+)
[PATCH] crypto:skcipher: fix kernel-doc warning for anonymous union member
Posted by Abdellah Ouhbi 3 weeks, 4 days ago
Fix htmldocs build warning
./include/crypto/skcipher.h:167 struct member 'SKCIPHER_ALG_COMMON'
not described in 'skcipher_alg'

The struct skcipher_alg contains an anonymous union with a macro-defined
member SKCIPHER_ALG_COMMON that was not documented.
Add documentation following the pattern used in other headers
for similar anonymous members.

Signed-off-by: Abdellah Ouhbi <abdououhbi1@gmail.com>
---
 include/crypto/skcipher.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/crypto/skcipher.h b/include/crypto/skcipher.h
index 9e5853464345..4efe2ca8c4d1 100644
--- a/include/crypto/skcipher.h
+++ b/include/crypto/skcipher.h
@@ -145,6 +145,7 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
  * 	      considerably more efficient if it can operate on multiple chunks
  * 	      in parallel. Should be a multiple of chunksize.
  * @co: see struct skcipher_alg_common
+ * @SKCIPHER_ALG_COMMON: see struct skcipher_alg_common
  *
  * All fields except @ivsize are mandatory and must be filled.
  */
-- 
2.51.0