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

[svn_grass at osgeo.org]

Author: martinl
Date: 2013-04-03 09:01:45 -0700 (Wed, 03 Apr 2013)
New Revision: 55607

Modified:
   grass/trunk/lib/gis/file_name.c
   grass/trunk/lib/gis/legal_name.c
Log:
libgis: dox cosmetics


Modified: grass/trunk/lib/gis/file_name.c
===================================================================
--- grass/trunk/lib/gis/file_name.c	2013-04-03 11:28:15 UTC (rev 55606)
+++ grass/trunk/lib/gis/file_name.c	2013-04-03 16:01:45 UTC (rev 55607)
@@ -1,14 +1,12 @@
 /*!
-   \file file_name.c
+   \file lib/gis/file_name.c
 
-   \brief GIS library - Determice GRASS data base file name
+   \brief GIS library - Determine GRASS data base file name
 
-   (C) 2001-2008 by the GRASS Development Team
+   (C) 2001-2008, 2013 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.
+   This program is free software under the GNU General Public License
+   (>=v2).  Read the file COPYING that comes with GRASS for details.
 
    \author Original author CERL
  */
@@ -21,16 +19,16 @@
 /*!
   \brief Builds full path names to GIS data files
 
-  If name is of the form "nnn at ppp" then path is set
-  as if name had been nnn and mapset had been ppp
-  (mapset parameter itself is ignored in this case)
+  If name is of the form "nnn at ppp" then path is set as if name had
+  been nnn and mapset had been ppp (mapset parameter itself is ignored
+  in this case).
   
   \param[out] path buffer to hold resultant full path to file
   \param element database element (eg, "cell", "cellhd", etc)
   \param name name of file to build path to (fully qualified names allowed)
   \param mapset mapset name
 
-  \return pointer to <i>path</i>
+  \return pointer to <i>path</i> buffer
 */
 char *G_file_name(char *path,
 		   const char *element, const char *name, const char *mapset)

Modified: grass/trunk/lib/gis/legal_name.c
===================================================================
--- grass/trunk/lib/gis/legal_name.c	2013-04-03 11:28:15 UTC (rev 55606)
+++ grass/trunk/lib/gis/legal_name.c	2013-04-03 16:01:45 UTC (rev 55607)
@@ -1,9 +1,9 @@
 /*!
- * \file gis/legal_name.c
+ * \file lib/gis/legal_name.c
  *
  * \brief GIS Library - Functions to handle file name legality.
  *
- * (C) 2001-2009 by the GRASS Development Team
+ * (C) 2001-2009, 2013 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.
@@ -16,7 +16,6 @@
 #include <grass/gis.h>
 #include <grass/glocale.h>
 
-
 /*!
  * \brief Check for legal database file name.
  *
@@ -25,6 +24,8 @@
  * quote), '@', ',', '=', '*', and all other non-alphanumeric
  * characters within.
  *
+ * The function prints a warning on error.
+ *
  * \param s file name to check
  *
  * \return 1 success
@@ -52,8 +53,10 @@
 /*!
  * \brief Check input and output file names.
  *
- * Check: 1) output is legal map name, 2) if can find input map, and
- * 3) if input was found in current mapset, check if input != output.
+ * Check: 
+ *  1) output is legal map name,
+ *  2) if can find input map, and
+ *  3) if input was found in current mapset, check if input != output.
  *
  * \param input input map name
  * \param output output map name