[PATCH] crypto:scompress: fix kernel-doc warning and spelling error

[PATCH] crypto:scompress: fix kernel-doc warning and spelling error

[Abdellah Ouhbi]

Fix htmldocs build warning:
./include/crypto/internal/scompress.h:39 struct member
'COMP_ALG_COMMON' not described in 'scomp_alg'

The struct scomp_alg contains an anonymous union member defined by
macro COMP_ALG_COMMON that was not documented. Add documentation
following the pattern used in other crypto headers for similar
anonymous members.

Also fix spelling error in existing comment: "Cmonn" to "Common".

Signed-off-by: Abdellah Ouhbi <abdououhbi1@gmail.com>
---
 include/crypto/internal/scompress.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/crypto/internal/scompress.h b/include/crypto/internal/scompress.h
index 6a2c5f2e90f9..f91a2c3487ef 100644
--- a/include/crypto/internal/scompress.h
+++ b/include/crypto/internal/scompress.h
@@ -21,7 +21,8 @@ struct crypto_scomp {
  * @compress:	Function performs a compress operation
  * @decompress:	Function performs a de-compress operation
  * @streams:	Per-cpu memory for algorithm
- * @calg:	Cmonn algorithm data structure shared with acomp
+ * @calg:	Common algorithm data structure shared with acomp
+ * @COMP_ALG_COMMON: see struct comp_alg_common in crypto/acompress.h
  */
 struct scomp_alg {
 	int (*compress)(struct crypto_scomp *tfm, const u8 *src,
-- 
2.51.0

[PATCH] crypto:scompress: fix kernel-doc warning and spelling error

[Abdellah Ouhbi]

Fix htmldocs build warning:
./include/crypto/internal/scompress.h:39 struct member
'COMP_ALG_COMMON' not described in 'scomp_alg'

The struct scomp_alg contains an anonymous union member defined by
macro COMP_ALG_COMMON that was not documented. Add documentation
following the pattern used in other crypto headers for similar
anonymous members.

Also fix spelling error in existing comment: "Cmonn" to "Common".

Signed-off-by: Abdellah Ouhbi <abdououhbi1@gmail.com>
---
 include/crypto/internal/scompress.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/crypto/internal/scompress.h b/include/crypto/internal/scompress.h
index 6a2c5f2e90f9..f91a2c3487ef 100644
--- a/include/crypto/internal/scompress.h
+++ b/include/crypto/internal/scompress.h
@@ -21,7 +21,8 @@ struct crypto_scomp {
  * @compress:	Function performs a compress operation
  * @decompress:	Function performs a de-compress operation
  * @streams:	Per-cpu memory for algorithm
- * @calg:	Cmonn algorithm data structure shared with acomp
+ * @calg:	Common algorithm data structure shared with acomp
+ * @COMP_ALG_COMMON: see struct comp_alg_common in crypto/acompress.h
  */
 struct scomp_alg {
 	int (*compress)(struct crypto_scomp *tfm, const u8 *src,
-- 
2.51.0