Added doxygen comments for the main eurephiadm parts

1 files changed, 26 insertions, 0 deletions

diff --git a/eurephiadm/client_context.c b/eurephiadm/client_context.c
index ebf4371..040e9d6 100644
--- a/eurephiadm/client_context.c
+++ b/eurephiadm/client_context.c
@@ -19,6 +19,15 @@
  *
 */
 
+/**
+ * @file   client_context.c
+ * @author David Sommerseth <dazo@users.sourceforge.net>
+ * @date   2008-12-01
+ *
+ * @brief  Functions for working with eurephiaCTX outside the openvpn plug-in
+ *
+ */
+
 #include <stdio.h>
 #include <string.h>
 #include <assert.h>
@@ -30,6 +39,16 @@
 #include <eurephiadb.h>
 
 
+/**
+ * Initialises a new eurephiaCTX.  This function also initialises the database driver, which must
+ * be configured in the configuration.
+ *
+ * @param log      FILE pointer where to put log data
+ * @param loglevel Set the log level (verbosity)
+ * @param cfg      eurephiaVALUES pointer to the configuration
+ *
+ * @return Returns a pointer to a eurephiaCTX, otherwise NULL.
+ */
 eurephiaCTX *eurephiaCTX_init(FILE *log, const int loglevel, eurephiaVALUES *cfg) {
         eurephiaCTX *ctx = NULL;
         char *dbdriver = NULL, *logfile = NULL;
@@ -86,6 +105,13 @@ eurephiaCTX *eurephiaCTX_init(FILE *log, const int loglevel, eurephiaVALUES *cfg
         return ctx;
 }
 
+
+/**
+ * Takes care of tearing down a eurephiaCTX in a proper way.  It will disconnect from the 
+ * database and unload the database driver if needed.
+ *
+ * @param ctx eurephiaCTX to take down.
+ */
 void eurephiaCTX_destroy(eurephiaCTX *ctx) {
         if( ctx == NULL ) {
                 return;