Bläddra i källkod

libgis: dox cosmetics

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@55607 15284696-431f-4ddb-bdfa-cd5b030d7da7
Martin Landa 12 år sedan
förälder
incheckning
87da4ee948
2 ändrade filer med 17 tillägg och 16 borttagningar
  1. 9 11
      lib/gis/file_name.c
  2. 8 5
      lib/gis/legal_name.c

+ 9 - 11
lib/gis/file_name.c

@@ -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@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@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)

+ 8 - 5
lib/gis/legal_name.c

@@ -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 @@ int G_legal_filename(const char *s)
 /*!
  * \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