From 47810232c2dfbb6ef0a661064a35ac58f14d4a5e Mon Sep 17 00:00:00 2001 From: Alex 'AdUser' Z Date: Fri, 14 Oct 2016 16:03:50 +1000 Subject: [PATCH] filter.h : doxygen comments --- src/filter.h | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/src/filter.h b/src/filter.h index 6795023..6210735 100644 --- a/src/filter.h +++ b/src/filter.h @@ -10,18 +10,29 @@ #include "config.h" #include "log.h" +/** filter module definition */ typedef struct f2b_filter_t { - void *h; - void *cfg; - char file[PATH_MAX]; + void *h; /**< dlopen handler */ + void *cfg; /**< opaque pointer of module config */ + char file[PATH_MAX]; /**< path to file with patterns */ + /* handlers */ + /** dlsym pointer to handler of @a create command */ void *(*create) (const char *id); + /** dlsym pointer to handler of @a config command */ bool (*config) (void *cfg, const char *key, const char *value); + /** dlsym pointer to handler of @a append command */ bool (*append) (void *cfg, const char *pattern); + /** dlsym pointer to handler of @a error command */ char *(*error) (void *cfg); + /** dlsym pointer to handler of @a ready command */ bool (*ready) (void *cfg); + /** dlsym pointer to handler of @a flush command */ bool (*flush) (void *cfg); + /** dlsym pointer to handler of @a stats command */ bool (*stats) (void *cfg, int *matches, char **pattern, bool reset); + /** dlsym pointer to handler of @a match command */ bool (*match) (void *cfg, const char *line, char *buf, size_t buf_size); + /** dlsym pointer to handler of @a destroy command */ void (*destroy) (void *cfg); } f2b_filter_t;