Browse Source

Minor doxygen sync to trunk

git-svn-id: https://svn.osgeo.org/grass/grass/branches/releasebranch_7_0@62957 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 10 years ago
parent
commit
45902d14cb
3 changed files with 19 additions and 23 deletions
  1. 14 12
      lib/gis/basename.c
  2. 1 7
      lib/gis/mapset_nme.c
  3. 4 4
      lib/gis/nme_in_mps.c

+ 14 - 12
lib/gis/basename.c

@@ -1,17 +1,15 @@
 
-/**
- * \file basename.c
+/*!
+ * \file lib/gis/basename.c
  *
  * \brief GIS Library - Program basename routines.
  *
- * (C) 2001-2008 by the GRASS Development Team
+ * (C) 2001-2014 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 GRASS GIS Development Team
- *
- * \date 1999-2007
  */
 
 #include <grass/gis.h>
@@ -23,7 +21,7 @@
 #include <stdlib.h>
 
 
-/**
+/*!
  * \brief Truncates filename to the base part (before the last '.')
  * if it matches the extension, otherwise leaves it unchanged.
  * 
@@ -31,12 +29,12 @@
  * (case insensitive) and if so, truncates the string to the
  * base file name (cf. basename Unix command)
  *
- * \param[in] filename string containing filename
- * \param[in] desired_ext string containing extension to look for (case
+ * \param filename string containing filename
+ * \param desired_ext string containing extension to look for (case
  * insensitive)
- * \return Pointer to filename
+ *
+ * \return pointer to filename
  */
-
 char *G_basename(char *filename, const char *desired_ext)
 {
     /* Find the last . in the filename */
@@ -106,9 +104,13 @@ char *G_double_to_basename_format(double number,
 
 
 /*!
- * \brief Return the environmental basename variable or the default value
+ * \brief Return the environmental basename variable or the default
+ * value
+ *
+ * return pointer to basename separator
  */
-char *G_get_basename_separator(){
+char *G_get_basename_separator()
+{
     char *envvar = "GRASS_BASENAME_SEPARATOR";
     char *envsep;
 

+ 1 - 7
lib/gis/mapset_nme.c

@@ -30,7 +30,7 @@ static struct state *st = &state;
 static void new_mapset(const char *);
 
 /*!
-   \brief Get name of the n'th mapset from the mapset_name[] list.
+   \brief Get name of the n'th mapset from the current mapset search path.
 
    The first call will initialize the list.
 
@@ -97,8 +97,6 @@ void new_mapset(const char *name)
 
 /*!
    \brief Define alternative mapset search path
-
-   \return 0
  */
 void G_create_alt_search_path(void)
 {
@@ -110,8 +108,6 @@ void G_create_alt_search_path(void)
 
 /*!
    \brief Switch mapset search path
-
-   \return 0
  */
 void G_switch_search_path(void)
 {
@@ -130,8 +126,6 @@ void G_switch_search_path(void)
 
 /*!
    \brief Reset number of mapsets
-
-   \return 0
  */
 void G_reset_mapsets(void)
 {

+ 4 - 4
lib/gis/nme_in_mps.c

@@ -122,10 +122,10 @@ char *G_fully_qualified_name(const char *name, const char *mapset)
    - <i>name, xname</i> are char array of size GNAME_MAX
    - <i>mapset, xmapset</i> are char array of size GMAPSET_MAX
 
-  \param fullname map name
-  \param map mapset to check or NULL
-  \param[out] name map name
-  \param[out] mapset mapset name
+  \param name map name
+  \param mapset mapset to check or NULL
+  \param[out] xname map name
+  \param[out] xmapset mapset name
 
   \return  1 if input map name is fully qualified
   \return  0 if name is not fully qualified