Browse Source

- doxygen conversion, write new documentation, small cleanups

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4963 689a6050-402a-0410-94f2-e92a70836424
Henning Westerholt 17 years ago
parent
commit
e7d596848e

+ 17 - 12
modules/db_postgres/km_db_postgres.c

@@ -1,8 +1,6 @@
-/* 
+/*
  * $Id$ 
  *
- * Postgres module interface
- *
  * Copyright (C) 2001-2003 FhG Fokus
  * Copyright (C) 2008 1&1 Internet AG
  *
@@ -21,11 +19,18 @@
  * You should have received a copy of the GNU General Public License 
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
+ */
+
+/*! \defgroup db_postgres DB_POSTGRES :: the PostgreSQL driver for Kamailio
+ *  \brief The Kamailio database interface to the PostgreSQL database
+ *  - http://www.postgresql.org
  *
- * History:
- * --------
- *  2003-03-11  updated to the new module exports interface (andrei)
- *  2003-03-16  flags export parameter added (janakj)
  */
 
 #include <stdio.h>
@@ -34,6 +39,7 @@
 #include "../../db/db.h"
 #include "dbase.h"
 
+
 MODULE_VERSION
 
 int db_postgres_bind_api(db_func_t *dbb);
@@ -51,13 +57,13 @@ static cmd_export_t cmds[]={
 
 
 
-struct module_exports exports = {	
+struct module_exports exports = {
 	"db_postgres",
 	DEFAULT_DLFLAGS, /* dlopen flags */
 	cmds,
-	0,   /*  module parameters */
-	0,   /* exported statistics */
-	0,   /* exported MI functions */
+	0,        /*  module parameters */
+	0,        /* exported statistics */
+	0,        /* exported MI functions */
 	0,        /* exported pseudo-variables */
 	0,        /* extra processes */
 	mod_init, /* module initialization function */
@@ -92,4 +98,3 @@ int db_postgres_bind_api(db_func_t *dbb)
 
 	return 0;
 }
-

+ 102 - 126
modules/db_postgres/km_dbase.c

@@ -1,9 +1,6 @@
 /*
  * $Id$
  *
- * POSTGRES module, portions of this code were templated using
- * the mysql module, thus it's similarity.
- *
  * Copyright (C) 2003 August.Net Services, LLC
  * Copyright (C) 2006 Norman Brandinger
  * Copyright (C) 2008 1&1 Internet AG
@@ -24,8 +21,6 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
- * ---
- *
  * History
  * -------
  * 2003-04-06 initial code written (Greg Fausak/Andy Fullford)
@@ -63,6 +58,13 @@
  *            to be taken. (norm)
  */
 
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
+ */
+
+/*! maximum number of columns */
 #define MAXCOLUMNS	512
 
 #include <string.h>
@@ -80,56 +82,35 @@
 static int free_query(const db_con_t* _con);
 
 
-/*
-** pg_init	initialize database for future queries
-**
-**	Arguments :
-**		char *_url;	sql database to open
-**
-**	Returns :
-**		db_con_t * NULL upon error
-**		db_con_t * if successful
-**
-**	Notes :
-**		pg_init must be called prior to any database functions.
-*/
-
+/*!
+ * \brief Initialize database for future queries
+ * \param _url URL of the database that should be opened
+ * \return database connection on success, NULL on error
+ * \note this function must be called prior to any database functions
+ */
 db_con_t *db_postgres_init(const str* _url)
 {
 	return db_do_init(_url, (void*) db_postgres_new_connection);
 }
 
 
-/*
-** pg_close	last function to call when db is no longer needed
-**
-**	Arguments :
-**		db_con_t * the connection to shut down, as supplied by pg_init()
-**
-**	Returns :
-**		(void)
-**
-**	Notes :
-**		All memory and resources are freed.
-*/
-
+/*!
+ * \brief Close database when the database is no longer needed
+ * \param _h closed connection, as returned from db_postgres_init
+ * \note free all memory and resources
+ */
 void db_postgres_close(db_con_t* _h)
 {
 	db_do_close(_h, db_postgres_free_connection);
 }
 
-/*
-** submit_query	run a query
-**
-**	Arguments :
-**		db_con_t *	as previously supplied by pg_init()
-**		char *_s	the text query to run
-**
-**	Returns :
-**		0 upon success
-**		negative number upon failure
-*/
 
+/*!
+ * \brief Submit_query, run a query
+ * \param _h database connection
+ * \param _s query string
+ * \return 0 on success, negative on failure
+ */
 static int db_postgres_submit_query(const db_con_t* _con, const str* _s)
 {
 	if(! _con || !_s || !_s->s)
@@ -178,10 +159,13 @@ static int db_postgres_submit_query(const db_con_t* _con, const str* _s)
 	return 0;
 }
 
-/*
- *
- * pg_fetch_result: Gets a partial result set.
- *
+
+/*!
+ * \brief Gets a partial result set
+ * \param _con database connection
+ * \param _res result set
+ * \param nrows number of fetches rows
+ * \return 0 on success, negative on failure
  */
 int db_postgres_fetch_result(const db_con_t* _con, db_res_t** _res, const int nrows)
 {
@@ -301,17 +285,12 @@ int db_postgres_fetch_result(const db_con_t* _con, db_res_t** _res, const int nr
 	return 0;
 }
 
-/*
-** free_query	clear the db channel and clear any old query result status
-**
-**	Arguments :
-**		db_con_t *	as previously supplied by pg_init()
-**
-**	Returns :
-**		0 upon success
-**		negative number upon failure
-*/
 
+/*!
+ * \brief Free database and any old query results
+ * \param _h database connection
+ * \return 0
+ */
 static int free_query(const db_con_t* _con)
 {
 	if(CON_RESULT(_con))
@@ -324,18 +303,13 @@ static int free_query(const db_con_t* _con)
 	return 0;
 }
 
-/*
-** db_free_result	free the query and free the result memory
-**
-**	Arguments :
-**		db_con_t *	as previously supplied by pg_init()
-**		db_res_t *	the result of a query
-**
-**	Returns :
-**		0 upon success
-**		negative number upon failure
-*/
 
+/*!
+ * \brief Free the query and the result memory in the core
+ * \param _con database connection
+ * \param _r result set
+ * \return 0
+ */
 int db_postgres_free_result(db_con_t* _con, db_res_t* _r)
 {
 	free_query(_con);
@@ -345,16 +319,18 @@ int db_postgres_free_result(db_con_t* _con, db_res_t* _r)
 	return 0;
 }
 
-/*
- * Query table for specified rows
- * _con: structure representing database connection
- * _k: key names
- * _op: operators
- * _v: values of the keys that must match
- * _c: column names to return
- * _n: nmber of key=values pairs to compare
- * _nc: number of columns to return
- * _o: order by the specified column
+
+/*!
+ * \brief Query table for specified rows
+ * \param _con structure representing database connection
+ * \param _k key names
+ * \param _op operators
+ * \param _v values of the keys that must match
+ * \param _c column names to return
+ * \param _n nmber of key=values pairs to compare
+ * \param _nc number of columns to return
+ * \param _o order by the specified column
+ * \return 0 on success, negative on failure
  */
 int db_postgres_query(const db_con_t* _h, const db_key_t* _k, const db_op_t* _op,
 	     const db_val_t* _v, const db_key_t* _c, const int _n, const int _nc,
@@ -365,8 +341,12 @@ int db_postgres_query(const db_con_t* _h, const db_key_t* _k, const db_op_t* _op
 }
 
 
-/*
+/*!
  * Execute a raw SQL query
+ * \param _h database connection
+ * \param _s raw query string
+ * \param _r result set
+ * \return 0 on success, negative on failure
  */
 int db_postgres_raw_query(const db_con_t* _h, const str* _s, db_res_t** _r)
 {
@@ -374,30 +354,20 @@ int db_postgres_raw_query(const db_con_t* _h, const str* _s, db_res_t** _r)
 		db_postgres_store_result);
 }
 
-/*
- * Retrieve result set
- *
- * Input:
- *   db_con_t*  _con Structure representing the database connection
- *   db_res_t** _r pointer to a structure represending the result set
- *
- * Output:
- *   return 0: If the status of the last command produced a result set and,
+
+/*!
+ * \brief Retrieve result set
+ * \param _con structure representing the database connection
+ * \param _r pointer to a structure represending the result set
+ * \return 0 If the status of the last command produced a result set and,
  *   If the result set contains data or the convert_result() routine
- *   completed successfully.
- *
- *   return < 0: If the status of the last command was not handled or if the
- *   convert_result() returned an error.
- *
- * Notes:
- *   A new result structure is allocated on every call to this routine.
- *
- *   If this routine returns 0, it is the callers responsbility to free the
- *   result structure. If this routine returns < 0, then the result structure
- *   is freed before returning to the caller.
- *
+ *   completed successfully. Negative if the status of the last command was
+ * not handled or if the convert_result() returned an error.
+ * \note A new result structure is allocated on every call to this routine.
+ * If this routine returns 0, it is the callers responsbility to free the
+ * result structure. If this routine returns < 0, then the result structure
+ * is freed before returning to the caller.
  */
-
 int db_postgres_store_result(const db_con_t* _con, db_res_t** _r)
 {
 	PGresult *res = NULL;
@@ -476,12 +446,14 @@ done:
 	return (rc);
 }
 
-/*
- * Insert a row into specified table
- * _con: structure representing database connection
- * _k: key names
- * _v: values of the keys
- * _n: number of key=value pairs
+
+/*!
+ * \brief Insert a row into specified table
+ * \param _h structure representing database connection
+ * \param _k key names
+ * \param _v values of the keys
+ * \param _n number of key=value pairs
+ * \return 0 on success, negative on failure
  */
 int db_postgres_insert(const db_con_t* _h, const db_key_t* _k, const db_val_t* _v,
 		const int _n)
@@ -500,13 +472,14 @@ int db_postgres_insert(const db_con_t* _h, const db_key_t* _k, const db_val_t* _
 }
 
 
-/*
- * Delete a row from the specified table
- * _con: structure representing database connection
- * _k: key names
- * _o: operators
- * _v: values of the keys that must match
- * _n: number of key=value pairs
+/*!
+ * \brief Delete a row from the specified table
+ * \param _h structure representing database connection
+ * \param _k key names
+ * \param _o operators
+ * \param _v values of the keys that must match
+ * \param _n number of key=value pairs
+ * \return 0 on success, negative on failure
  */
 int db_postgres_delete(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o,
 		const db_val_t* _v, const int _n)
@@ -525,16 +498,17 @@ int db_postgres_delete(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o
 }
 
 
-/*
+/*!
  * Update some rows in the specified table
- * _con: structure representing database connection
- * _k: key names
- * _o: operators
- * _v: values of the keys that must match
- * _uk: updated columns
- * _uv: updated values of the columns
- * _n: number of key=value pairs
- * _un: number of columns to update
+ * \param _h structure representing database connection
+ * \param _k key names
+ * \param _o operators
+ * \param _v values of the keys that must match
+ * \param _uk updated columns
+ * \param _uv updated values of the columns
+ * \param _n number of key=value pairs
+ * \param _un number of columns to update
+ * \return 0 on success, negative on failure
  */
 int db_postgres_update(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o,
 		const db_val_t* _v, const db_key_t* _uk, const db_val_t* _uv, const int _n,
@@ -554,9 +528,11 @@ int db_postgres_update(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o
 }
 
 
-/*
- * Store name of table that will be used by
- * subsequent database functions
+/*!
+ * Store name of table that will be used by subsequent database functions
+ * \param _con database connection
+ * \param _t table name
+ * \return 0 on success, negative on error
  */
 int db_postgres_use_table(db_con_t* _con, const str* _t)
 {

+ 16 - 17
modules/db_postgres/km_dbase.h

@@ -1,9 +1,6 @@
 /*
  * $Id$
  *
- * POSTGRES module, portions of this code were templated using
- * the mysql module, thus it's similarity.
- *
  * Copyright (C) 2003 August.Net Services, LLC
  * Copyright (C) 2008 1&1 Internet AG
  *
@@ -23,14 +20,16 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
- * ---
- *
  * History
  * -------
  * 2003-04-06 initial code written (Greg Fausak/Andy Fullford)
- *
  */
 
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
+ */
 
 #ifndef DBASE_H
 #define DBASE_H
@@ -42,69 +41,69 @@
 #include "../../db/db_val.h"
 
 
-/**
+/*
  * Initialize database connection
  */
 db_con_t* db_postgres_init(const str* _url);
 
-/**
+/*
  * Close a database connection
  */
 void db_postgres_close(db_con_t* _h);
 
-/**
+/*
  * Return result of previous query
  */
 int db_postgres_store_result(const db_con_t* _h, db_res_t** _r);
 
 
-/**
+/*
  * Free all memory allocated by get_result
  */
 int db_postgres_free_result(db_con_t* _h, db_res_t* _r);
 
 
-/**
+/*
  * Do a query
  */
 int db_postgres_query(const db_con_t* _h, const db_key_t* _k, const db_op_t* _op,
 		const db_val_t* _v, const db_key_t* _c, const int _n, const int _nc,
 		const db_key_t _o, db_res_t** _r);
 
-/**
+/*
  * Raw SQL query
  */
 int db_postgres_raw_query(const db_con_t* _h, const str* _s, db_res_t** _r);
 
 
-/**
+/*
  * Insert a row into table
  */
 int db_postgres_insert(const db_con_t* _h, const db_key_t* _k, const db_val_t* _v,
 		const int _n);
 
 
-/**
+/*
  * Delete a row from table
  */
 int db_postgres_delete(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o,
 		const db_val_t* _v, const int _n);
 
 
-/**
+/*
  * Update a row in table
  */
 int db_postgres_update(const db_con_t* _h, const db_key_t* _k, const db_op_t* _o,
 		const db_val_t* _v, const db_key_t* _uk, const db_val_t* _uv, const int _n,
 		const int _un);
 
-/**
+/*
  * fetch rows from a result
  */
 int db_postgres_fetch_result(const db_con_t* _h, db_res_t** _r, const int nrows);
 
 
-/**
+/*
  * Store name of table that will be used by
  * subsequent database functions
  */

+ 16 - 5
modules/db_postgres/km_pg_con.c

@@ -21,6 +21,12 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
+ */
+
 #include "pg_con.h"
 #include "../../mem/mem.h"
 #include "../../dprint.h"
@@ -29,9 +35,13 @@
 #include <time.h>
 
 
-/*
- * Create a new connection structure,
- * open the PostgreSQL connection and set reference count to 1
+/*!
+ * \brief Create a new connection
+ *
+ * Create a new connection structure in private memory, open the PostgreSQL
+ * connection and set reference count to 1
+ * \param id database id
+ * \return postgres connection structure, 0 on error
  */
 struct pg_con* db_postgres_new_connection(struct db_id* id)
 {
@@ -91,8 +101,9 @@ struct pg_con* db_postgres_new_connection(struct db_id* id)
 }
 
 
-/*
- * Close the connection and release memory
+/*!
+ * \brief Close the connection and release memory
+ * \param con connection
  */
 void db_postgres_free_connection(struct pool_con* con)
 {

+ 17 - 18
modules/db_postgres/km_pg_con.h

@@ -1,10 +1,8 @@
 /*
  * $Id$
  *
- * POSTGRES module, portions of this code were templated using
- * the mysql module, thus it's similarity.
- *
  * Copyright (C) 2003 August.Net Services, LLC
+ * Copyright (C) 2008 1&1 Internet AG
  *
  * This file is part of Kamailio, a free SIP server.
  *
@@ -22,14 +20,16 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
- * ---
- *
  * History
  * -------
  * 2003-04-06 initial code written (Greg Fausak/Andy Fullford)
- *
  */
 
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_mysql
+ */
 
 #ifndef PG_CON_H
 #define PG_CON_H
@@ -40,20 +40,19 @@
 #include <time.h>
 #include <libpq-fe.h>
 
-/*
- * Postgres specific connection data
- */
+
+/*! Postgres specific connection data */
 struct pg_con {
-	struct db_id* id;        /* Connection identifier */
-	unsigned int ref;        /* Reference count */
-	struct pool_con* next;   /* Next connection in the pool */
+	struct db_id* id;        /*!< Connection identifier */
+	unsigned int ref;        /*!< Reference count */
+	struct pool_con* next;   /*!< Next connection in the pool */
 
-	int connected;
-	char *sqlurl;		/* the url we are connected to, all connection memory parents from this */
-	PGconn *con;		/* this is the postgres connection */
-	PGresult *res;		/* this is the current result */
-	char**  row;		/* Actual row in the result */
-	time_t timestamp;	/* Timestamp of last query */
+	int connected;      /*!< connection status */
+	char *sqlurl;		/*!< the url we are connected to, all connection memory parents from this */
+	PGconn *con;		/*!< this is the postgres connection */
+	PGresult *res;		/*!< this is the current result */
+	char**  row;		/*!< Actual row in the result */
+	time_t timestamp;	/*!< Timestamp of last query */
 
 };
 

+ 30 - 15
modules/db_postgres/km_res.c

@@ -1,9 +1,6 @@
 /*
  * $Id$
  *
- * POSTGRES module, portions of this code were templated using
- * the mysql module, thus it's similarity.
- *
  * Copyright (C) 2003 August.Net Services, LLC
  * Copyright (C) 2006 Norman Brandinger
  * Copyright (C) 2008 1&1 Internet AG
@@ -24,8 +21,6 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
- * ---
- *
  * History
  * -------
  * 2003-04-06 initial code written (Greg Fausak/Andy Fullford)
@@ -37,7 +32,12 @@
  *            Removed dependency on aug_* memory routines (norm)
  *            Added connection pooling support (norm)
  *            Standardized API routines to pg_* names (norm)
- *
+ */
+
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
  */
 
 #include <stdlib.h>
@@ -53,9 +53,11 @@
 #include "pg_type.h"
 
 
-
-/**
- * Fill the result structure with data from the query
+/*!
+ * \brief Fill the result structure with data from the query
+ * \param _h database connection
+ * \param _r result set
+ * \return 0 on success, negative on error
  */
 int db_postgres_convert_result(const db_con_t* _h, db_res_t* _r)
 {
@@ -77,8 +79,12 @@ int db_postgres_convert_result(const db_con_t* _h, db_res_t* _r)
 	return 0;
 }
 
-/**
- * Get and convert columns from a result set
+
+/*!
+ * \brief Get and convert columns from a result set
+ * \param _h database connection
+ * \param _r result set
+ * \return 0 on success, negative on error
  */
 int db_postgres_get_columns(const db_con_t* _h, db_res_t* _r)
 {
@@ -184,8 +190,12 @@ int db_postgres_get_columns(const db_con_t* _h, db_res_t* _r)
 	return 0;
 }
 
-/**
- * Convert rows from PostgreSQL to db API representation
+
+/*!
+ * \brief Convert rows from PostgreSQL to db API representation
+ * \param _h database connection
+ * \param _r result set
+ * \return 0 on success, negative on error
  */
 int db_postgres_convert_rows(const db_con_t* _h, db_res_t* _r)
 {
@@ -308,8 +318,13 @@ int db_postgres_convert_rows(const db_con_t* _h, db_res_t* _r)
 }
 
 
-/**
- * Convert a row from the result query into db API representation
+/*!
+ * \brief Convert a row from the result query into db API representation
+ * \param _h database connection
+ * \param _r result set
+ * \param _row row
+ * \param row_buf row buffer
+ * \param 0 on success, negative on error
  */
 int db_postgres_convert_row(const db_con_t* _h, db_res_t* _r, db_row_t* _row,
 		char **row_buf)

+ 6 - 1
modules/db_postgres/km_res.h

@@ -3,7 +3,6 @@
  *
  * Copyright (C) 2007 1&1 Internet AG
  *
- *
  * This file is part of Kamailio, a free SIP server.
  *
  * Kamailio is free software; you can redistribute it and/or modify
@@ -22,6 +21,12 @@
  *
  */
 
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
+ */
+
 #ifndef DB_PG_RES_H
 #define DB_PG_RES_H
 

+ 23 - 10
modules/db_postgres/km_val.c

@@ -1,9 +1,6 @@
 /*
  * $Id$
  *
- * POSTGRES module, portions of this code were templated using
- * the mysql module, thus it's similarity.
- *
  * Copyright (C) 2003 August.Net Services, LLC
  * Copyright (C) 2008 1&1 Internet AG
  *
@@ -23,17 +20,19 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
- * ---
- *
  * History
  * -------
  * 2003-04-06 initial code written (Greg Fausak/Andy Fullford)
  * 2003-04-14 gmtime changed to localtime because mktime later
  *            expects localtime, changed daylight saving bug
  *            previously found in mysql module (janakj)
- *
  */
 
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
+ */
 
 #include "../../db/db_val.h"
 #include "../../db/db_ut.h"
@@ -47,10 +46,17 @@
 #include <time.h>
 
 
-/*
- * Convert a str to a db value, does not copy strings
+/*!
+ * \brief Convert a str to a db value, does not copy strings
+ *
+ * Convert a str to a db value, does not copy strings.
  * The postgresql module uses a custom escape function for BLOBs.
  * If the _s is linked in the db_val result, it will be returned zero
+ * \param _t destination value type
+ * \param _v destination value
+ * \param _s source string
+ * \param _l string length
+ * \return 0 on success, negative on error
  */
 int db_postgres_str2val(const db_type_t _t, db_val_t* _v, const char* _s, const int _l)
 {
@@ -165,8 +171,15 @@ int db_postgres_str2val(const db_type_t _t, db_val_t* _v, const char* _s, const
 }
 
 
-/*
- * Used when converting result from a query
+/*!
+ * \brief Converting a value to a string
+ *
+ * Converting a value to a string, used when converting result from a query
+ * \param _con database connection
+ * \param _v source value
+ * \param _s target string
+ * \param _len target string length
+ * \return 0 on success, negative on error
  */
 int db_postgres_val2str(const db_con_t* _con, const db_val_t* _v, char* _s, int* _len)
 {

+ 6 - 2
modules/db_postgres/km_val.h

@@ -3,7 +3,6 @@
  *
  * Copyright (C) 2007 1&1 Internet AG
  *
- *
  * This file is part of Kamailio, a free SIP server.
  *
  * Kamailio is free software; you can redistribute it and/or modify
@@ -19,7 +18,12 @@
  * You should have received a copy of the GNU General Public License 
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
- *
+ */
+
+/*! \file
+ *  \brief DB_POSTGRES :: Core
+ *  \ingroup db_postgres
+ *  Module: \ref db_postgres
  */
 
 #ifndef DB_PG_VAL_H