From c563c1091ea8c2119bcc8097d965b359b4bbdfde Mon Sep 17 00:00:00 2001
From: Alex 'AdUser' Z <ad_user@runbox.com>
Date: Fri, 14 Oct 2016 15:59:50 +1000
Subject: [PATCH] source.h : doxygen comments

---
 src/source.h | 30 +++++++++++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

diff --git a/src/source.h b/src/source.h
index 64b8040..05fd57b 100644
--- a/src/source.h
+++ b/src/source.h
@@ -10,22 +10,46 @@
 #include "config.h"
 #include "log.h"
 
+/** source module definition */
 typedef struct f2b_source_t {
-  void *h;
-  void *cfg;
+  void *h;   /**< dlopen handler */
+  void *cfg; /**< opaque pointer of module config */
+  /* handlers */
+  /** dlsym pointer to handler of @a create command */
   void *(*create)  (const char *init);
+  /** dlsym pointer to handler of @a config command */
   bool  (*config)  (void *cfg, const char *key, const char *value);
+  /** dlsym pointer to handler of @a ready command */
   bool  (*ready)   (void *cfg);
+  /** dlsym pointer to handler of @a error command */
   char *(*error)   (void *cfg);
+  /** dlsym pointer to handler of @a errcb command */
   void  (*errcb)   (void *cfg, void (*cb)(const char *errstr));
+  /** dlsym pointer to handler of @a start command */
   bool  (*start)   (void *cfg);
+  /** dlsym pointer to handler of @a next command */
   bool  (*next)    (void *cfg, char *buf, size_t bufsize, bool reset);
+  /** dlsym pointer to handler of @a stop command */
   bool  (*stop)    (void *cfg);
+  /** dlsym pointer to handler of @a destroy command */
   void  (*destroy) (void *cfg);
 } f2b_source_t;
 
+/**
+ * @brief Create module from config
+ * @param config Pointer to section of config
+ * @param init   Module init string
+ * @param errcb  Error callback
+ * @returns Pointer to module metadata of NULL on error
+ */
 f2b_source_t * f2b_source_create  (f2b_config_section_t *config, const char *init, void (*errcb)(const char *));
-void           f2b_source_destroy (f2b_source_t *s);
+/**
+ * @brief Free module metadata
+ * @param b Pointer to module struct
+ */
+void f2b_source_destroy (f2b_source_t *s);
+
+/* helpers */
 bool           f2b_source_start   (f2b_source_t *s);
 bool           f2b_source_next    (f2b_source_t *s, char *buf, size_t bufsize, bool reset);
 bool           f2b_source_stop    (f2b_source_t *s);