doxygen comments in get_row.c are wrong?

[karme]

Either the code in get_row.c is wrong or the the doxygen strings. G_get_raster_row does not return 0 if the row is outside the window.

Attached a patch trying to fix this. Note: this was a quick hack I tested while trying to speed up d.rast => only supplied to explain the problem.

[neteler]

Devs: any opinion?

[glynn]

Replying to 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.

[mlennert]

Replying to glynn:

Replying to 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 ?

[glynn]

Replying to mlennert:

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

Right.

The internal functions compute_window_row() and get_map_row_nomask() return 0 if the row is outside of the map's data, but that detail doesn't propagate up to any of the documented public functions.

[mlennert]

Replying to glynn:

Replying to mlennert:

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

Right.

The internal functions compute_window_row() and get_map_row_nomask() return 0 if the row is outside of the map's data, but that detail doesn't propagate up to any of the documented public functions.

Correction of doxygen comment committed to devel6 (r60143) and rel64 (r60144).

Closing the bug.

Moritz