aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/genalloc.h
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2017-08-31 09:47:22 -0600
committerJonathan Corbet <corbet@lwn.net>2017-08-31 09:47:22 -0600
commita27bfcab5c1c3a0df61b68e85fc5e4cade83559f (patch)
tree5e56160c8a9fac7dd21c661178d6df7e07d4084a /include/linux/genalloc.h
parentdoc: Add documentation for the genalloc subsystem (diff)
downloadlinux-dev-a27bfcab5c1c3a0df61b68e85fc5e4cade83559f.tar.xz
linux-dev-a27bfcab5c1c3a0df61b68e85fc5e4cade83559f.zip
genalloc: Fix an incorrect kerneldoc comment
The kerneldoc comment for the genpool_algo_t typedef was incomplete and incorrectly formatted, leading to a raft of warnings during the docs build. Fix it appropriately. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'include/linux/genalloc.h')
-rw-r--r--include/linux/genalloc.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/linux/genalloc.h b/include/linux/genalloc.h
index 29d4385903d4..6dfec4d638df 100644
--- a/include/linux/genalloc.h
+++ b/include/linux/genalloc.h
@@ -38,12 +38,13 @@ struct device_node;
struct gen_pool;
/**
- * Allocation callback function type definition
+ * typedef genpool_algo_t: Allocation callback function type definition
* @map: Pointer to bitmap
* @size: The bitmap size in bits
* @start: The bitnumber to start searching at
* @nr: The number of zeroed bits we're looking for
- * @data: optional additional data used by @genpool_algo_t
+ * @data: optional additional data used by the callback
+ * @pool: the pool being allocated from
*/
typedef unsigned long (*genpool_algo_t)(unsigned long *map,
unsigned long size,