[GRASS-SVN] r47154 - grass/trunk/lib/gis

[svn_grass at osgeo.org]

Author: martinl
Date: 2011-07-18 02:15:35 -0700 (Mon, 18 Jul 2011)
New Revision: 47154

Modified:
   grass/trunk/lib/gis/env.c
Log:
gislib: update env.c doxygen documentation


Modified: grass/trunk/lib/gis/env.c
===================================================================
--- grass/trunk/lib/gis/env.c	2011-07-18 09:06:41 UTC (rev 47153)
+++ grass/trunk/lib/gis/env.c	2011-07-18 09:15:35 UTC (rev 47154)
@@ -276,7 +276,7 @@
 /*!
   \brief Get environment variable
   
-  Calls G_fatal_error() if name not set.
+  G_fatal_error() is called when variable is not found.
   
   \param name variable name
   
@@ -289,12 +289,12 @@
     if (value)
 	return value;
 
-    G_fatal_error(_("G_getenv(): Variable %s not set"), name);
+    G_fatal_error(_("Variable '%s' not set"), name);
     return NULL;
 }
 
 /*!
-  \brief Read variable from specific place
+  \brief Get variable from specific place
   
   Locations:
    - G_VAR_GISRC
@@ -303,7 +303,7 @@
   G_fatal_error() is called when variable is not found.
   
   \param name variable name
-  \param loc location id
+  \param loc location (G_VAR_GISRC, G_VAR_MAPSET)
    
   \return variable value
   \return NULL if not found
@@ -315,7 +315,7 @@
     if (value)
 	return value;
 
-    G_fatal_error(_("%s not set"), name);
+    G_fatal_error(_("Variable '%s' not set"), name);
     return NULL;
 }
 
@@ -341,7 +341,7 @@
   \brief Get environment variable from specific place
   
   \param name variable name
-  \param loc location id
+  \param loc location (G_VAR_GISRC, G_VAR_MAPSET)
   
   \return char pointer to value for name
   \return NULL if name not set
@@ -357,11 +357,10 @@
 }
 
 /*!
-  \brief Set environment variable
+  \brief Set environment variable (updates .gisrc)
 
   If value is NULL, becomes an G_unsetenv().
-  Updates .gisrc
-  
+    
   \param name variable name
   \param value variable value
 */
@@ -373,11 +372,9 @@
 }
 
 /*!
-  \brief Set environment variable from specific place
+  \brief Set environment variable from specific place (updates .gisrc)
   
   If value is NULL, becomes an G_unsetenv().
-  Updates .gisrc
-
   
   \param name variable name
   \param value variable value
@@ -392,7 +389,7 @@
 }
 
 /*!
-  \brief Set environment name to value
+  \brief Set environment name to value (doesn't update .gisrc)
   
   \param name variable name
   \param value variable value
@@ -404,11 +401,11 @@
 }
 
 /*!
-  \brief Set environment name to value from specific place
+  \brief Set environment name to value from specific place (doesn't update .gisrc)
   
   \param name variable name
   \param value variable value
-  \param loc location id
+  \param loc location (G_VAR_GISRC, G_VAR_MAPSET)
 */
 void G__setenv2(const char *name, const char *value, int loc)
 {
@@ -436,7 +433,7 @@
   Updates .gisrc
   
   \param name variable name
-  \param loc location id
+  \param loc location (G_VAR_GISRC, G_VAR_MAPSET)
 */
 void G_unsetenv2(const char *name, int loc)
 {