[GRASS-SVN] r41400 - grass/trunk/lib/db/dbmi_base

[svn_grass at osgeo.org]

Author: martinl
Date: 2010-03-12 08:58:39 -0500 (Fri, 12 Mar 2010)
New Revision: 41400

Modified:
   grass/trunk/lib/db/dbmi_base/default_name.c
Log:
doxygen update


Modified: grass/trunk/lib/db/dbmi_base/default_name.c
===================================================================
--- grass/trunk/lib/db/dbmi_base/default_name.c	2010-03-12 13:43:35 UTC (rev 41399)
+++ grass/trunk/lib/db/dbmi_base/default_name.c	2010-03-12 13:58:39 UTC (rev 41400)
@@ -1,3 +1,17 @@
+/*!
+  \file db/dbmi_base/default_name.c
+  
+  \brief DBMI Library (base) - default settings
+  
+  (C) 1999-2010 by the GRASS Development Team
+  
+  This program is free software under the GNU General Public License
+  (>=v2). Read the file COPYING that comes with GRASS for details.
+  
+  \author Joel Jones (CERL/UIUC)
+  \author Upgraded to GRASS 5.7 by Radim Blazek
+*/
+
 #include <stdlib.h>
 #include <string.h>
 #include <grass/gis.h>
@@ -2,8 +16,10 @@
 #include <grass/dbmi.h>
+#include <grass/glocale.h>
 
 /*!
-   \fn const char * db_get_default_driver_name ( void )
-   \brief returns pointer to default driver name
-   \return returns pointer to default driver name or NULL if not set
- */
+  \brief Get default driver name
+
+  \return pointer to default driver name
+  \return NULL if not set
+*/
 const char *db_get_default_driver_name(void)
@@ -19,10 +35,11 @@
 }
 
 /*!
-   \fn const char * db_get_default_database_name ( void )
-   \brief returns pointer to default database name
-   \return returns pointer to default database name or NULL if not set
- */
+  \brief Get default database name
+
+  \return pointer to default database name
+  \return NULL if not set
+*/
 const char *db_get_default_database_name(void)
 {
     const char *drv;
@@ -34,10 +51,11 @@
 }
 
 /*!
-   \fn const char * db_get_default_schema_name ( void )
-   \brief returns pointer to default schema name
-   \return returns pointer to default schema name or NULL if not set
- */
+  \brief Get default schema name
+  
+  \return pointer to default schema name
+  \return NULL if not set
+*/
 const char *db_get_default_schema_name(void)
 {
     const char *sch;
@@ -49,10 +67,11 @@
 }
 
 /*!
-   \fn const char * db_get_default_group_name ( void )
-   \brief returns pointer to default group name
-   \return returns pointer to default group name or NULL if not set
- */
+  \brief Get default group name
+  
+  \return pointer to default group name
+  \return NULL if not set
+*/
 const char *db_get_default_group_name(void)
 {
     const char *gr;
@@ -63,13 +82,13 @@
     return NULL;
 }
 
+/*!
+  \brief Sets up database connection settings using GRASS default from dbmi.h
 
+  \todo DB_OK on success, DB_* error code on fail
 
-/*!
-   \fn int db_set_default_connection(void)
-   \brief sets up database connection settings using GRASS default from dbmi.h
-   \return returns DB_OK (TODO: DB_OK on success, DB_* error code on fail)
- */
+  \return returns DB_OK 
+*/
 int db_set_default_connection(void)
 {
     dbConnection connection;
@@ -105,7 +124,7 @@
 	db_set_connection(&connection);
     }
     else
-	G_fatal_error("Programmer error");
+	G_fatal_error(_("Programmer error"));
 
     return DB_OK;
 }