Doxygen comments to eurephia_context.h

1 files changed, 28 insertions, 20 deletions

diff --git a/common/eurephia_context.h b/common/eurephia_context.h
index b91d1a6..1ec637d 100644
--- a/common/eurephia_context.h
+++ b/common/eurephia_context.h
@@ -19,8 +19,16 @@
  *
 */
 
+/**
+ * @file   eurephia_context.h
+ * @author David Sommerseth <dazo@users.sourceforge.net>
+ * @date   2008-08-06
+ *
+ * @brief  eurephia context structure definition.
+ *
+ */
 
-/*** Structures used by the eurphia module  ***/
+/*** Structures used by the eurephia module  ***/
 
 #ifndef   	EUREPHIASTRUCT_H_
 #define   	EUREPHIASTRUCT_H_
@@ -28,31 +36,31 @@
 #include <stdio.h>
 #include "eurephiadb_struct.h"
 
-#define ECTX_NO_PRIVILEGES 0x1000
-#define ECTX_PLUGIN_AUTH   0x1001
-#define ECTX_ADMIN_CONSOLE 0x2001
-#define ECTX_ADMIN_WEB     0x2002
+#define ECTX_NO_PRIVILEGES 0x1000 /**< The context should not have any privileges at all */
+#define ECTX_PLUGIN_AUTH   0x1001 /**< The context is used in a openvpn plug-in setting */
+#define ECTX_ADMIN_CONSOLE 0x2001 /**< The context is used via the eurephiadm console utility */
+#define ECTX_ADMIN_WEB     0x2002 /**< The context is used via a web based utility */
 
-#define SIZE_PWDCACHE_SALT 2048
+#define SIZE_PWDCACHE_SALT 2048 /**< Defines the size of the in-memory password salt */
 
-//
-//  main structure for the eurephia module context
-//  - the same context structure is used for all OpenVPN sessions
-//
+/**
+ * main structure for the eurephia module context
+ * - the same context structure is used for all OpenVPN sessions
+ */
 typedef struct {
-        void *eurephia_driver;
-        void *eurephia_fw_intf;
-        eDBconn *dbc;
+        void *eurephia_driver;  /**< Pointer to the eurephia database drivers handler */
+        void *eurephia_fw_intf; /**< Pointer to the eurephia firewall interface handler */
+        eDBconn *dbc;           /**< Pointer to an eurephia database connection */
 #ifdef EUREPHIA_FWINTF
-        eurephiaFWINTF *fwcfg;
+        eurephiaFWINTF *fwcfg;  /**< Pointer to the firewall configuration */
 #else
-        void *fwcfg;
+        void *fwcfg;            /**< Dummy pointer, if the firewall API is not enabled */
 #endif
-        char *server_salt;
-        FILE *log;
-        int loglevel;
-        int fatal_error;
-        int context_type;
+        char *server_salt;      /**< The in-memory password salt, used for the password cache */
+        FILE *log;              /**< FILE pointer to the log file */
+        int loglevel;           /**< Defines the log verbosity, higher number increases log verbosity */
+        int fatal_error;        /**< If this flag is set, the execution should stop immediately */
+        int context_type;       /**< Defines the context type */
 } eurephiaCTX;
 
 #endif