Diff: map/map_public.h

Revision:

6:5ed435a31cc7

Parent:

0:7fe3c940e4b5

--- a/map/map_public.h	Sun Jul 05 21:52:08 2015 +0000
+++ b/map/map_public.h	Sun Jul 05 21:58:24 2015 +0000
@@ -1,4 +1,4 @@
-/* Gatech ECE2035 2015 SPRING PAC MAN
+/*Gatech ECE2035 2015 SUMMER ROBOFROGGER
  * Copyright (c) 2015 Gatech ECE2035
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -26,11 +26,11 @@
 /// The enum define the status of a grid on the map
 typedef enum {
     GRID_SIDE_WALK=0,   //Side_walk
-    GRID_CANDY,         ///< A candy
+    GRID_CANDY,         ///A candy
     GRID_BIG_CANDY,     // Bigger candy!
     GRID_ROAD_L,        //Road left
-    GRID_ROAD,
-    GRID_ROAD_R,
+    GRID_ROAD,          //Middle of the road
+    GRID_ROAD_R,        //Road right
     GRID_V_LINE,        //V_line
     GRID_SIDE_WALK_2,
 } GRID_STATUS;
@@ -47,11 +47,11 @@
 */
 void map_init(void);
 
-/** Remove the cookie/super-cookie from map
+/** Remove the candy/big-candy from map
     @brief It could be called by Pacman when it eat the cookie.
     @param grid_x The horizontal position in the grid.
     @param grid_y The vertical position in the grid.
-    @return 1:There is a cookie be eaten. 0:The is no cookie at the grid.
+    @return 1:There is a candy be eaten. 0:The is no candy at the grid.
 */
 bool map_eat_candy(int grid_x, int grid_y);
 
@@ -68,8 +68,8 @@
 */
 void map_draw_grid(unsigned grid_x, unsigned grid_y);
 
-/** Get the number of remaining cookie.
-    @brief The game should be ended when there is no cookie.
+/** Get the number of remaining candy.
+    @brief The game should be ended when there is no candy.
     @return The number of remaining cookie.
 */
 int  map_remaining_candy(void);