mm: list_lru: Update kernel documentation to follow the requirements
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Thu, 23 Nov 2023 17:23:17 +0000 (19:23 +0200)
committerAndrew Morton <akpm@linux-foundation.org>
Mon, 11 Dec 2023 00:51:52 +0000 (16:51 -0800)
commit7679e14098c9c3c8118a7130d6e1e9cfe2565c04
treee83b87f9d8268426e1855d07a6f912dd252c6001
parente9119fb65761f124b31743b598ce04b8f15a6fe3
mm: list_lru: Update kernel documentation to follow the requirements

kernel-doc is not happy about documentation in list_lru.h:

list_lru.h:90: warning: Function parameter or member 'lru' not described in 'list_lru_add'
list_lru.h:90: warning: Excess function parameter 'list_lru' description in 'list_lru_add'
list_lru.h:90: warning: No description found for return value of 'list_lru_add'
list_lru.h:103: warning: Function parameter or member 'lru' not described in 'list_lru_del'
list_lru.h:103: warning: Excess function parameter 'list_lru' description in 'list_lru_del'
list_lru.h:103: warning: No description found for return value of 'list_lru_del'
list_lru.h:116: warning: No description found for return value of 'list_lru_count_one'
list_lru.h:168: warning: No description found for return value of 'list_lru_walk_one'
list_lru.h:185: warning: No description found for return value of 'list_lru_walk_one_irq'

Fix the documentation accordingly.

While at it, fix the references to the parameters in functions
inside the long descriptions, on which the above script is not
complaining (yet?).

Link: https://lkml.kernel.org/r/20231123172320.2434780-1-andriy.shevchenko@linux.intel.com
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
include/linux/list_lru.h