]> rtime.felk.cvut.cz Git - eurobot/public.git/commitdiff
shared map documentation: add FIXME cries and update
authorFilip Jares <filipjares@post.cz>
Sat, 24 Apr 2010 10:01:47 +0000 (12:01 +0200)
committerFilip Jares <filipjares@post.cz>
Sat, 24 Apr 2010 10:01:47 +0000 (12:01 +0200)
src/pathplan/map.c
src/pathplan/map.h

index 884ef3673eb5f7e4701caf769db8e05835d66d48..e713441398bbd82f4a874b8e32b311d737c965ca 100644 (file)
@@ -276,7 +276,8 @@ void ShmapPoint2Cell(double x, double y, int *ix, int *iy, bool *valid){
 }
 
 /**
- * @brief Translates from cell grid coordinates to real coordinates. 
+ * @brief Translates from cell grid coordinates to real coordinates. Coordinates set to
+   *x and *y are coordinates of the center of given cell.
  * @param ix   given x index of grid cell
  * @param iy   given y index of grid cell
  * @param *x   is set to real x coordinate corresponding to given ix
index da22a35132493a4daeab5027c377c12c135ca6cb..5db0cfb772463fcb427be8114d5e0be47c148887 100644 (file)
 
  * @subsection map_func Accessing to map information
  * 
+ * FIXME: Obsolete: ShmapGetPointValue(), ShmapSetPointValue(),
+ * ShmapSetPointValue(), ShmapSetCellValue() do not exist
+ *
  * To read and write cell values, use functions ShmapGetCellValue()
  * and ShmapSetCellValue(). If you want to acces directly to points,
  * you can also use ShmapGetPointValue() and ShmapSetPointValue().