diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2018-04-16 12:32:55 -0700 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2018-04-16 18:53:13 -0400 |
| commit | 5968a70d7af5f2abbd9d9f9c8e86da51f0a6b16d (patch) | |
| tree | 43bb11706900c554dc499ae8e8c31b12e4b66486 /include/linux/textsearch.h | |
| parent | 1c9f0a946d5c6d3d6a83cfee0e8bb4e886559a67 (diff) | |
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>
Diffstat (limited to 'include/linux/textsearch.h')
| -rw-r--r-- | include/linux/textsearch.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/textsearch.h b/include/linux/textsearch.h index 0494db3fd9e8..13770cfe33ad 100644 --- a/include/linux/textsearch.h +++ b/include/linux/textsearch.h @@ -62,7 +62,7 @@ struct ts_config int flags; /** - * get_next_block - fetch next block of data + * @get_next_block: fetch next block of data * @consumed: number of bytes consumed by the caller * @dst: destination buffer * @conf: search configuration @@ -79,7 +79,7 @@ struct ts_config struct ts_state *state); /** - * finish - finalize/clean a series of get_next_block() calls + * @finish: finalize/clean a series of get_next_block() calls * @conf: search configuration * @state: search state * |