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

[svn_grass at osgeo.org]

Author: martinl
Date: 2009-10-18 14:29:16 -0400 (Sun, 18 Oct 2009)
New Revision: 39567

Modified:
   grass/trunk/lib/db/dbmi_base/dbmscap.c
Log:
dbmscap.c: initial doxygen strings


Modified: grass/trunk/lib/db/dbmi_base/dbmscap.c
===================================================================
--- grass/trunk/lib/db/dbmi_base/dbmscap.c	2009-10-18 18:03:58 UTC (rev 39566)
+++ grass/trunk/lib/db/dbmi_base/dbmscap.c	2009-10-18 18:29:16 UTC (rev 39567)
@@ -1,3 +1,17 @@
+/*!
+  \file db/dbmi_base/dbmscap.c
+  
+  \brief DBMI Library (base) - DBmscap management
+  
+  (C) 1999-2009 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), Radim Blazek
+*/
+
 #include <stdio.h>
 #include <string.h>
 #include <stdlib.h>
@@ -17,7 +31,7 @@
 
 static void add_entry();
 
-static char *dbmscap_filename(err_flag)
+static char *dbmscap_filename(int err_flag)
 {
     char *file;
     int i;
@@ -37,33 +51,32 @@
 }
 
 /*!
-   \fn 
-   \brief 
-   \return 
-   \param 
- */
+  \brief Get dbmscap file name
+
+  \return pointer to string with file name
+*/
 const char *db_dbmscap_filename(void)
 {
     return dbmscap_filename(1);
 }
 
 /*!
-   \fn 
-   \brief 
-   \return 
-   \param 
- */
+  \brief Check dbms
+
+  \return 1 if true
+  \return 0 if false
+*/
 int db_has_dbms(void)
 {
     return (dbmscap_filename(0) != NULL);
 }
 
 /*!
-   \fn 
-   \brief 
-   \return 
-   \param 
- */
+  \brief Copy dbmscap entry
+
+  \param dst destination
+  \param src source
+*/
 void db_copy_dbmscap_entry(dbDbmscap * dst, dbDbmscap * src)
 {
     strcpy(dst->driverName, src->driverName);
@@ -72,18 +85,17 @@
 }
 
 /*!
-   \fn 
-   \brief 
-   \return 
-   \param 
- */
-/* dbmscap file was used in grass5.0 but it is not used in
- * grass5.7 until we find it necessary. All code for dbmscap
- * file is commented here. 
- *
- * Instead of in dbmscap file db_read_dbmscap() searches 
- * for available dbmi drivers in $(GISBASE)/driver/db/  */
+  \brief Read dbmscap
+  
+  dbmscap file was used in grass5.0 but it is not used in
+  grass5.7 until we find it necessary. All code for dbmscap
+  file is commented here. 
+  
+  Instead of in dbmscap file db_read_dbmscap() searches 
+  for available dbmi drivers in $(GISBASE)/driver/db/
 
+  \return pointer to dbDbmscap
+*/
 dbDbmscap *db_read_dbmscap(void)
 {
     /*  
@@ -221,11 +233,10 @@
 }
 
 /*!
-   \fn 
-   \brief 
-   \return 
-   \param 
- */
+  \brief Free dbmscap 
+
+  \param list pointer to dbDbmscap
+*/
 void db_free_dbmscap(dbDbmscap * list)
 {
     dbDbmscap *next, *cur;