genalloc: Fix an incorrect kerneldoc comment
authorJonathan Corbet <corbet@lwn.net>
Thu, 31 Aug 2017 15:47:22 +0000 (09:47 -0600)
committerJonathan Corbet <corbet@lwn.net>
Thu, 31 Aug 2017 15:47:22 +0000 (09:47 -0600)
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>
include/linux/genalloc.h

index 29d4385903d456c274e56d258741fa51002881ce..6dfec4d638df3e7b10811191aba871e421c8d724 100644 (file)
@@ -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,