[GRASS-SVN] r57787 - grass/trunk/lib/raster3d

[svn_grass at osgeo.org]

Author: wenzeslaus
Date: 2013-09-21 20:11:18 -0700 (Sat, 21 Sep 2013)
New Revision: 57787

Modified:
   grass/trunk/lib/raster3d/color.c
   grass/trunk/lib/raster3d/raster3dlib.dox
Log:
dox: updating the color section of raster 3D main page and adding comments into color.c file

Modified: grass/trunk/lib/raster3d/color.c
===================================================================
--- grass/trunk/lib/raster3d/color.c	2013-09-22 00:54:30 UTC (rev 57786)
+++ grass/trunk/lib/raster3d/color.c	2013-09-22 03:11:18 UTC (rev 57787)
@@ -17,6 +17,13 @@
 
 /*---------------------------------------------------------------------------*/
 
+/*!
+   \brief Removes the primary and/or secondary color file.
+
+   \todo Is <em>primary and/or secondary color file</em> still valid for 7?
+
+   \see G_remove_colr
+*/
 int Rast3d_remove_color(const char *name)
  /* adapted from G_remove_colr */
 {
@@ -25,8 +32,16 @@
 
 /*---------------------------------------------------------------------------*/
 
-int
-Rast3d_read_colors(const char *name, const char *mapset, struct Colors *colors)
+/*!
+   \brief Reads color file for map \p name in \p mapset into the Colors structure.
+
+   \param name 3D raster map name
+   \param mapset mapset name
+   \param colors colors to be associated with a map
+
+   \see Rast3d_write_colors, Rast_read_colors
+*/
+int Rast3d_read_colors(const char *name, const char *mapset, struct Colors *colors)
  /* adapted from Rast_read_colors */
 {
     const char *err;
@@ -321,8 +336,16 @@
 
 /*---------------------------------------------------------------------------*/
 
-int
-Rast3d_write_colors(const char *name, const char *mapset, struct Colors *colors)
+/*!
+   \brief Writes the \p colors for map \p name in \p mapset into a color file.
+
+   \param name 3D raster map name
+   \param mapset mapset name
+   \param colors colors to be associated with a map
+
+   \see Rast3d_read_colors, Rast3d_remove_color, Rast_write_colors
+*/
+int Rast3d_write_colors(const char *name, const char *mapset, struct Colors *colors)
  /* adapted from Rast_write_colors */
 {
     FILE *fd;

Modified: grass/trunk/lib/raster3d/raster3dlib.dox
===================================================================
--- grass/trunk/lib/raster3d/raster3dlib.dox	2013-09-22 00:54:30 UTC (rev 57786)
+++ grass/trunk/lib/raster3d/raster3dlib.dox	2013-09-22 03:11:18 UTC (rev 57787)
@@ -1343,33 +1343,14 @@
 
 \subsection RASTER3D_Color_Support RASTER3D Color Support
 
-<P>
-Applications can use the standard GRASS functions to work with colors, except
-for the file manipulations.
+Applications can use the standard GRASS functions to work with colors,
+e.g. Rast_get_d_color_range(). However, the file manipulations must be handled
+using specialized raster 3D functions.
 
-<P>
-int Rast3d_removeColor(char *name)
-Removes the primary and/or secondary color file. See <EM>G_remove_colr</EM> for
-details.
+Rast3d_read_colors() function reads color file for a map into a Colors structure.
+Rast3d_write_colors() function stores colors in color files for a map and
+Rast3d_remove_color() function removes the color file.
 
-<P>
-Returns always 0.
-
-<P>
-int Rast3d_readColors(char *name, char *mapset, struct Colors
-   *colors) Reads color file for map <EM>name</EM> in <EM>mapset</EM> into the
-   <EM>colors</EM> structure.  See <EM>G_read_colors</EM>
-   (Raster_Color_Table) for details and return values.
-
-<P>
-int Rast3d_writeColors(char *name, char *mapset, struct Colors
-   *colors)Writes colors stored in <EM>colors</EM> structure into the color
-   file for map <EM>name</EM> in <EM>mapset</EM>.  See <EM>G_write_colors</EM>
-   (Raster_Color_Table) for
-   details and return values.
-
-<P>
-
 \subsection RASTER3D_Categories_Support RASTER3D Categories Support
 
 <P>