Browse Source

attempt at documenting what G__unqualified_name() does

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@38582 15284696-431f-4ddb-bdfa-cd5b030d7da7
Markus Neteler 15 years ago
parent
commit
0a65cd0d5f
1 changed files with 19 additions and 0 deletions
  1. 19 0
      lib/gis/nme_in_mps.c

+ 19 - 0
lib/gis/nme_in_mps.c

@@ -106,6 +106,25 @@ char *G_fully_qualified_name(const char *name, const char *mapset)
     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)
 {