Documentation added

git-svn-id: https://vdr-muggle.svn.sourceforge.net/svnroot/vdr-muggle/trunk/muggle-plugin@128 e10066b5-e1e2-0310-b819-94efdf66514b

1 files changed, 18 insertions, 15 deletions

diff --git a/mg_tools.h b/mg_tools.h
index d56f7d8..3b7bf12 100644
--- a/mg_tools.h
+++ b/mg_tools.h
@@ -1,25 +1,29 @@
-/*******************************************************************/
 /*! \file  muggle_tools.h
- * \brief  A few util functions for standalone and plugin messaging
- * for the vdr muggle plugindatabase
- ******************************************************************** 
- * \version $Revision: 1.3 $
- * \date    $Date: 2004/05/28 15:29:18 $
+ *  \brief  A few utility functions for standalone and plugin messaging for the vdr muggle plugindatabase
+ *
+ * \version $Revision: 1.4 $
+ * \date    $Date: 2004/08/30 14:31:43 $
  * \author  Ralf Klueber, Lars von Wedel, Andreas Kellner
- * \author  file owner: $Author: lvw $
+ * \author  file owner: $Author: LarsAC $
  * 
  */
-/*******************************************************************/
-/* makes sur we dont use parse the same declarations twice */
+
+/* makes sure we don't use the same declarations twice */
 #ifndef _MUGGLE_TOOLS_H
 #define _MUGGLE_TOOLS_H
 
 #include <iostream>
 #include <string>
+#include <mysql/mysql.h>
+
+#define STANDALONE 1 // what's this?
+
+// mySql helper functions
 
-#include "mysql/mysql.h"
+MYSQL_RES* mgSqlReadQuery(  MYSQL *db, const char *fmt, ... );
+void       mgSqlWriteQuery( MYSQL *db, const char *fmt, ... );
 
-#define STANDALONE 1
+// Messaging functions
 
 void mgSetDebugLevel(int new_level);
 void mgDebug(int level, const char *fmt, ...);
@@ -27,9 +31,6 @@ void mgDebug( const char *fmt, ... );
 void mgWarning(const char *fmt, ...);
 void mgError(const char *fmt, ...);
 
-MYSQL_RES* mgSqlReadQuery(MYSQL *db, const char *fmt, ...);
-void mgSqlWriteQuery(MYSQL *db, const char *fmt, ...);
-
 #ifdef DEBUG
 #define MGLOG(x) mgLog __thelog(x)
 #else
@@ -42,7 +43,6 @@ void mgSqlWriteQuery(MYSQL *db, const char *fmt, ...);
 #define MGLOGSTREAM __thelog.getStream()
 #endif
 
-
 class mgLog
 {
  public:
@@ -74,6 +74,9 @@ class mgLog
 
 /* -------------------- begin CVS log ---------------------------------
  * $Log: mg_tools.h,v $
+ * Revision 1.4  2004/08/30 14:31:43  LarsAC
+ * Documentation added
+ *
  * Revision 1.3  2004/05/28 15:29:18  lvw
  * Merged player branch back on HEAD branch.
  *