lib/gcd: add kernel-doc notation

Add kernel-doc notation for the gcd() function (so that it can be
added to the kernel-api documentation).

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

diff --git a/lib/gcd.c b/lib/gcd.c
index 135ee6407a5e4f0a6f7fc8da85f38a74ea37ed38..227dea9244257b014c36c54fb0768a961a5f5dcb 100644 (file)
--- a/lib/gcd.c
+++ b/lib/gcd.c
@@ -13,6 +13,12 @@
 #if !defined(CONFIG_CPU_NO_EFFICIENT_FFS) && !defined(CPU_NO_EFFICIENT_FFS)
 
 /* If __ffs is available, the even/odd algorithm benchmarks slower. */
+
+/**
+ * gcd - calculate and return the greatest common divisor of 2 unsigned longs
+ * @a: first value
+ * @b: second value
+ */
 unsigned long gcd(unsigned long a, unsigned long b)
 {
        unsigned long r = a | b;