crypto: api.c: adding doxygen comments to api
PATCH 1/1 crypto: api.c: adding doxygen comments to api
--- crypto/api.c | 14 ++++++++++++++ 1 files changed, 14 insertions(+), 0 deletions(-)
crypto/api.c +14 -0
@@ -193,6 +193,13 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* This gets the crypto_alg structure for an algorithm +* it return struct crypto_alg +* @name: name of the algorithm +* @type: crypto type (defined at about line 31 of include/linux/crypto.h) +* @mask: mask of allowable crypto types +*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
@@ -205,6 +212,13 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup); +/** +* This gets the large value crypto_alg structure for an algorithm +* it return struct crypto_alg +* @name: name of the algorithm +* @type: crypto type (defined at about line 31 of include/linux/crypto.h) +* @mask: mask of allowable crypto types +*/ struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
Signature · 1 line
1.6.3.3
Quoted 1 line · On Thu, 4 Nov 2010 09:32:42 -0700 Mark Allyn wrote:
Signed-off-by Mark A. Allyn <[email protected]>
We use kernel-doc notation in kernel sources, not doxygen.
Please see Documentation/kernel-doc-nano-HOWTO.txt for info, or ask me.
Thanks.
Quoted 27 lines
--- crypto/api.c | 14 ++++++++++++++ 1 files changed, 14 insertions(+), 0 deletions(-)crypto/api.c +7
-0@@ -193,6 +193,13 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* This gets the crypto_alg structure for an algorithm +* it return struct crypto_alg +* @name: name of the algorithm +* @type: crypto type (defined at about line 31 of include/linux/crypto.h) +* @mask: mask of allowable crypto types +*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;@@ -205,6 +212,13 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup);
crypto/api.c struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) · line 224
Quoted 10 lines
crypto/api.c +7
-0+/** +* This gets the large value crypto_alg structure for an algorithm +* it return struct crypto_alg +* @name: name of the algorithm +* @type: crypto type (defined at about line 31 of include/linux/crypto.h) +* @mask: mask of allowable crypto types +*/ struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
Quoted 1 line · Mark Allyn
Subject: [PATCH 1/1] crypto:
api.c: adding doxygen comments to api
Do we really use doxygen in the kernel? Perhaps a subject line containing the string 'kernel-doc' would be more accurate.
Reading kernel-doc-nano-HOWTO.txt will show you the proper format.
Quoted 10 lines
Signed-off-by Mark A. Allyn<[email protected]>--- crypto/api.c | 14 ++++++++++++++ 1 files changed, 14 insertions(+), 0 deletions(-)crypto/api.c +0
-0
crypto/api.c static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg) · line 200
Quoted 8 lines
crypto/api.c +5
-0@@ -193,6 +193,13 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)return alg; } +/** +* This gets the crypto_alg structure for an algorithm +* it return struct crypto_alg +* @name: name of the algorithm +* @type: crypto type (defined at about line 31 of include/linux/crypto.h)
Referencing kernel source file line numbers in documentation seems like an excellent way to have the documentation quickly be incorrect.
Quoted 19 lines
crypto/api.c +9
-0+* @mask: mask of allowable crypto types +*/ struct crypto_alg *crypto_alg_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;@@ -205,6 +212,13 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask) }EXPORT_SYMBOL_GPL (crypto_alg_lookup); +/** +* This gets the large value crypto_alg structure for an algorithm +* it return struct crypto_alg +* @name: name of the algorithm +* @type: crypto type (defined at about line 31 of include/linux/crypto.h) +* @mask: mask of allowable crypto types +*/ struct crypto_alg *crypto_larval_lookup (const char *name,u32 type,u32 mask) {struct crypto_alg *alg;