Diff: Food/Food.h

Revision:

6:1ad8c738b9b7

Parent:

3:7b28047013d2

Child:

7:cafa0b96e8d3

--- a/Food/Food.h	Thu May 02 07:48:32 2019 +0000
+++ b/Food/Food.h	Thu May 02 08:17:22 2019 +0000
@@ -14,17 +14,41 @@
     
     };
 /************************Class Def************************/   
+
+/** My Food Class
+* @brief Class for defining Food properties and states
+* @author Li Saiwen
+* @date May, 2019
+*/
+
 class Food{
     
     
 /************************Public Vars************************/  
     public:
-    
+            
+            /** Constructor */
             Food();
+            
+            /** Destructor */
             ~Food();
+            
+            /** initial Food coordinate
+            */
             void init();
+            
+            /** draw Food
+             * @param the subclass of N5110(lcd) 
+            */
             void drawfood(N5110 &lcd);
+            
+            /** create food randomly 
+            */
             void createfood();
+            
+            /** get the coordinate of the Food
+            * @return  food x/y coordinate
+            */
             Foodpos returnPos();
     
 /************************Private Vars************************/