[GRASS-dev] [GRASS GIS] #413: doxygen comments in get_row.c are wrong?

[GRASS GIS]

#413: doxygen comments in get_row.c are wrong?
-----------------------------------------+----------------------------------
 Reporter:  karme                        |       Owner:  grass-dev@…              
     Type:  defect                       |      Status:  new                      
 Priority:  major                        |   Milestone:  6.4.4                    
Component:  LibGIS                       |     Version:  svn-releasebranch64      
 Keywords:  G_get_raster_row(), doxygen  |    Platform:  All                      
      Cpu:  All                          |  
-----------------------------------------+----------------------------------

Comment(by mlennert):

 Replying to [comment:2 glynn]:
 > Replying to [ticket:413 karme]:
 > > Either the code in get_row.c is wrong or the the doxygen strings.
 >
 > The doxygen strings are wrong.
 >
 > > G_get_raster_row does not return 0 if the row is outside the window.
 >
 > There's no reason for higher-level code to care about what is
 essentially an implementation detail. It shouldn't matter whether the row
 is all-nulls because it's outside the array or because the stored data
 happens to be all-nulls.

 IIUC, return values are either 1 or -1, so just erasing the line in the
 comments mentioning "return 0" should be enough ?

-- 
Ticket URL: <https://trac.osgeo.org/grass/ticket/413#comment:4>
GRASS GIS <http://grass.osgeo.org>