textsearch: fix kernel-doc warnings and add kernel-api section
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 16 Apr 2018 19:32:55 +0000 (12:32 -0700)
committerDavid S. Miller <davem@davemloft.net>
Mon, 16 Apr 2018 22:53:13 +0000 (18:53 -0400)
commit5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d
tree43bb11706900c554dc499ae8e8c31b12e4b66486
parent1c9f0a946d5c6d3d6a83cfee0e8bb4e886559a67
textsearch: fix kernel-doc warnings and add kernel-api section

Make lib/textsearch.c usable as kernel-doc.
Add textsearch() function family to kernel-api documentation.
Fix kernel-doc warnings in <linux/textsearch.h>:
  ../include/linux/textsearch.h:65: warning: Incorrect use of kernel-doc format:
* get_next_block - fetch next block of data
  ../include/linux/textsearch.h:82: warning: Incorrect use of kernel-doc format:
* finish - finalize/clean a series of get_next_block() calls

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/core-api/kernel-api.rst
include/linux/textsearch.h
lib/textsearch.c