lkml.org 
[lkml]   [2010]   [Nov]   [4]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
DateThu, 4 Nov 2010 09:31:20 -0700
FromRandy Dunlap <>
SubjectRe: [PATCH 1/1] crypto: api.c: adding doxygen comments to api
On Thu,  4 Nov 2010 09:32:42 -0700 Mark Allyn wrote:

> Signed-off-by: Mark A. Allyn <mark.a.allyn@intel.com>

We use kernel-doc notation in kernel sources, not doxygen.

Please see Documentation/kernel-doc-nano-HOWTO.txt for info,
or ask me.

Thanks.

> ---
> crypto/api.c | 14 ++++++++++++++
> 1 files changed, 14 insertions(+), 0 deletions(-)
>
> diff --git a/crypto/api.c b/crypto/api.c
> index 033a714..a11939f 100644
> --- a/crypto/api.c
> +++ b/crypto/api.c
> @@ -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;
> --


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

\
 
 \ /
  Last update: 2010-11-04 17:35    [from the cache]
©2003-2010