Commit ea24ea85 authored by Naohiro Aota's avatar Naohiro Aota Committed by Jiri Kosina
Browse files

idr: fix kernel-doc warnings. 



Fix the following kernel-doc warnings.

% perl scripts/kernel-doc lib/idr.c > /dev/null
Warning(lib/idr.c:300): No description found for parameter 'starting_id'
Warning(lib/idr.c:300): Excess function parameter 'start_id' description in 'idr_get_new_above'
Warning(lib/idr.c:485): No description found for parameter 'idp'
Warning(lib/idr.c:596): No description found for parameter 'nextidp'
Warning(lib/idr.c:596): Excess function parameter 'id' description in 'idr_get_next'
Warning(lib/idr.c:774): No description found for parameter 'starting_id'
Warning(lib/idr.c:774): Excess function parameter 'staring_id' description in 'ida_get_new_above'
Warning(lib/idr.c:918): No description found for parameter 'ida'

Signed-off-by: default avatarNaohiro Aota <naota@elisp.net>
Acked-by: default avatarTejun Heo <tj@kernel.org>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent 10466f5a

lib/idr.c

+5 −5
Original line number Diff line number Diff line
@@ -284,7 +284,7 @@ static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id) 
 * idr_get_new_above - allocate new idr entry above or equal to a start id

 * @idp: idr handle

 * @ptr: pointer you want associated with the id

 * @start_id: id to start search at

 * @starting_id: id to start search at

 * @id: pointer to the allocated handle

 *

 * This is the allocate id function.  It should be called with any
@@ -479,7 +479,7 @@ EXPORT_SYMBOL(idr_remove_all); 


/**

 * idr_destroy - release all cached layers within an idr tree

 * idp: idr handle

 * @idp: idr handle

 */

void idr_destroy(struct idr *idp)

{
@@ -586,7 +586,7 @@ EXPORT_SYMBOL(idr_for_each); 
/**

 * idr_get_next - lookup next object of id to given id.

 * @idp: idr handle

 * @id:  pointer to lookup key

 * @nextidp:  pointer to lookup key

 *

 * Returns pointer to registered object with id, which is next number to

 * given id.
@@ -758,7 +758,7 @@ EXPORT_SYMBOL(ida_pre_get); 
/**

 * ida_get_new_above - allocate new ID above or equal to a start id

 * @ida:	ida handle

 * @staring_id:	id to start search at

 * @starting_id: id to start search at

 * @p_id:	pointer to the allocated handle

 *

 * Allocate new ID above or equal to @ida.  It should be called with
@@ -912,7 +912,7 @@ EXPORT_SYMBOL(ida_remove); 


/**

 * ida_destroy - release all cached layers within an ida tree

 * ida:		ida handle

 * @ida:		ida handle

 */

void ida_destroy(struct ida *ida)

{

CRA Git | Maintained and supported by SUSTech CRA and CCSE