Even more comments

1 files changed, 14 insertions, 4 deletions

diff --git a/plugin/firewall/eurephiafw_helpers.h b/plugin/firewall/eurephiafw_helpers.h
index aa00307..7ba93bb 100644
--- a/plugin/firewall/eurephiafw_helpers.h
+++ b/plugin/firewall/eurephiafw_helpers.h
@@ -20,13 +20,23 @@
  *
  */
 
+/**
+ * @file   eurephiafw_helpers.h
+ * @author David Sommerseth <dazo@users.sourceforge.net>
+ * @date   2009-08-14
+ *
+ * @brief  Helper functions which is shared between the main eurephia-auth module and
+ *         the firewall module.  It takes care of preparing POSIX MQ queues and semaphores.
+ *
+ */
+
 #ifndef   	EUREPHIAFW_HELPERS_H_
 #define   	EUREPHIAFW_HELPERS_H_
 
-#define EFW_MSG_SIZE  1024
-#define MQUEUE_NAME "/eurephiaFW"
-#define SEMPH_MASTER "eurephiafw_master"
-#define SEMPH_WORKER "eurephiafw_worker"
+#define EFW_MSG_SIZE  1024      /**< Maximum size of a message in the POSIX MQ queue */
+#define MQUEUE_NAME "/eurephiaFW" /**< Name of the MQ queue */
+#define SEMPH_MASTER "eurephiafw_master" /**< Name of the semaphore the main openvpn process uses */
+#define SEMPH_WORKER "eurephiafw_worker" /**< Name of the semaphore the firewall process uses */
 
 int efwSetupSemaphores(eurephiaCTX *, efw_threaddata *);
 int efwRemoveSemaphores(eurephiaCTX *, efw_threaddata *);