[GRASS-SVN] r63556 - grass/trunk/lib/display

[svn_grass at osgeo.org]

Author: martinl
Date: 2014-12-15 04:54:15 -0800 (Mon, 15 Dec 2014)
New Revision: 63556

Modified:
   grass/trunk/lib/display/raster.c
Log:
display: doxygen cosmetics

Modified: grass/trunk/lib/display/raster.c
===================================================================
--- grass/trunk/lib/display/raster.c	2014-12-15 12:42:10 UTC (rev 63555)
+++ grass/trunk/lib/display/raster.c	2014-12-15 12:54:15 UTC (rev 63556)
@@ -45,7 +45,7 @@
   \param colors pointer to Colors structure
   \param data_type raster type (CELL, FCELL, DCELL)
 
-  \return next row number needed for next pixel row
+  \return row number needed for next pixel row
   \return -1 nothing to draw (on error or end of raster)
 */
 int D_draw_raster(int A_row,
@@ -72,11 +72,12 @@
 /*!
   \brief Draw raster row (FCELL)
   
-  \param A_row row number
-  \param farray
+  \param A_row row number (starts at 0)
+  \param farray data buffer
   \param colors pointer to Colors structure
 
-  \return 
+  \return row number needed for next pixel row
+  \return -1 nothing to draw (on error or end of raster)
 */
 int D_draw_f_raster(int A_row, const FCELL * farray, struct Colors *colors)
 {
@@ -86,11 +87,12 @@
 /*!
   \brief Draw raster row (CELL)
   
-  \param A_row row number
-  \param carray
+  \param A_row row number (starts at 0)
+  \param carray data buffer
   \param colors pointer to Colors structure
 
-  \return 
+  \return row number needed for next pixel row
+  \return -1 nothing to draw (on error or end of raster)
 */
 int D_draw_c_raster(int A_row, const CELL * carray, struct Colors *colors)
 {
@@ -162,10 +164,9 @@
  
   The raster display subsystem establishes conversion parameters based
   on the screen extent defined by <b>top, bottom, left</b>, and
-  <b>right</b>, all of which are obtainable from <i>D_get_dst for the
-  current frame.</i>
+  <b>right</b>, all of which are obtainable from D_get_dst() for the
+  current frame.
 */
-
 void D_cell_draw_begin(void)
 {
     /* Set up the screen for drawing map */
@@ -177,7 +178,7 @@
 /*!
   \brief Draw raster row in RGB mode
 
-  \param A_row row number
+  \param A_row row number (starts at 0)
   \param r_raster red data buffer
   \param g_raster green data buffer
   \param b_raster blue data buffer
@@ -188,7 +189,8 @@
   \param g_type raster type used for red channel
   \param b_type raster type used for red channel
 
-  \return
+  \return row number needed for next pixel row
+  \return -1 nothing to draw (on error or end of raster)
 */
 int D_draw_raster_RGB(int A_row,
 		      const void *r_raster, const void *g_raster,