[GRASS-SVN] r47554 - grass/trunk/lib/raster

[svn_grass at osgeo.org]

Author: martinl
Date: 2011-08-11 03:59:15 -0700 (Thu, 11 Aug 2011)
New Revision: 47554

Modified:
   grass/trunk/lib/raster/color_remove.c
Log:
rasterlib: color_remove.c: add doxygen strings


Modified: grass/trunk/lib/raster/color_remove.c
===================================================================
--- grass/trunk/lib/raster/color_remove.c	2011-08-11 10:37:39 UTC (rev 47553)
+++ grass/trunk/lib/raster/color_remove.c	2011-08-11 10:59:15 UTC (rev 47554)
@@ -1,26 +1,30 @@
+/*!
+  \file lib/raster/color_remove.c
+ 
+  \brief Raster Library - remove color table of raster map
+  
+  (C) 2007 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 Glynn Clements
+*/
 
-/****************************************************************************
- *
- * MODULE:       gis library
- * AUTHOR(S):    Glynn Clements <glynn at gclements.plus.com>
- * COPYRIGHT:    (C) 2007 Glynn Clements
- *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
- *
- *****************************************************************************/
-
 #include <string.h>
 #include <stdio.h>
 #include <grass/gis.h>
 
+/*!
+  \brief Remove color table of raster map
+
+  \param name name of raster map
+  \param mapset name of mapset 
+
+  \return -1 on error
+  \return 0 color table not found
+  \return 1 on success
+*/
 int Rast_remove_colors(const char *name, const char *mapset)
 {
     char element[GMAPSET_MAX + 6];