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

[svn_grass at osgeo.org]

Author: neteler
Date: 2009-08-02 13:40:08 -0400 (Sun, 02 Aug 2009)
New Revision: 38582

Modified:
   grass/trunk/lib/gis/nme_in_mps.c
Log:
attempt at documenting what G__unqualified_name() does

Modified: grass/trunk/lib/gis/nme_in_mps.c
===================================================================
--- grass/trunk/lib/gis/nme_in_mps.c	2009-08-02 13:28:30 UTC (rev 38581)
+++ grass/trunk/lib/gis/nme_in_mps.c	2009-08-02 17:40:08 UTC (rev 38582)
@@ -106,6 +106,25 @@
     return G_store(fullname);
 }
 
+/*!
+  \brief Returns unqualified map name (without @ mapset)
+
+  Returns an unqualified name for the file <i>name</i> in
+  <i>mapset</i>.
+
+  Note:
+   - <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 fullname map mapset
+  \param[out] name map name
+  \param[out] mapset mapset name
+
+  \return  1 if input map name is fully qualified
+  \return  0 if ...
+  \return -1 if input mapset invalid
+ */
 int G__unqualified_name(const char *name, const char *mapset,
 			char *xname, char *xmapset)
 {