Diff: GPSGms6.h

Revision:

6:5e30784ffd54

Parent:

5:9dd9ab613497

Child:

7:333d46845050

--- a/GPSGms6.h	Wed May 18 17:28:10 2016 +0000
+++ b/GPSGms6.h	Thu May 19 06:51:52 2016 +0000
@@ -41,12 +41,21 @@
 #define INVALID_TIME_YEAR           0           /** Invalid year value   */
 
 /* ###############  Method Defination  ################## */
+/** @brief  Check if the indicator is valid
+  * @param  indicator - a char that represent the indicator message
+  * @retval True - if indicator is valid , otherwise, false .
+  */
 #define IS_INDICATOR_VALID(indicator)  ((indicator == (char)'A') || (indicator == (char)'D')|| (indicator == (char)'E'))
-#define IS_HEADER_GPRPC(buf)        buf[index] == 'G' &&    \
-                                    buf[index+1] == 'P' &&  \
-                                    buf[index+2] == 'R' &&  \
-                                    buf[index+3] == 'M' &&  \
-                                    buf[index+4] == 'C'     
+
+/** @brief  Check header is GPRMC header 
+  * @param  pointer to char array that contain message
+  * @retval True - if header is GPRMC , otherwise, false.
+  */
+#define IS_HEADER_GPRPC(buf)        (buf[index] == 'G' &&    \
+                                     buf[index+1] == 'P' &&  \
+                                     buf[index+2] == 'R' &&  \
+                                     buf[index+3] == 'M' &&  \
+                                     buf[index+4] == 'C'  )   
                                        
 
 /* ###############  Enum  ################## */