Diff: Patterns.h

Revision:

4:463abe5f5135

Parent:

0:12a1972fa0d0

--- a/Patterns.h	Sun May 01 23:09:33 2016 +0000
+++ b/Patterns.h	Thu May 05 09:18:01 2016 +0000
@@ -1,9 +1,27 @@
+/**
+@file Patterns.h
+@brief Header file containing member functions and variables
+@brief Header file patterns pixel settings and funtion to get specific pattern pixel setting
+@brief Revision 1.0.
+@author JIANWEI CHEN
+@date   May 2016
+*/
+
 #ifndef PATTERNS_H
 #define PATTERNS_H
+
+
 class Patterns
 {
 public:
-
+    /** Get pattern pixel setting
+    *
+    * @param type - pattern type (0~6)
+    * @param rotation - pattern rotation (0~3)
+    * @param y - pattern y co-ordinate  (0~6)
+    * @param x - pattern x co-ordinate (0~6)
+    * @note (x,y) is the top left corner pixel of a 6x6 square
+    */
     int getPatterns(int type, int rotation, int y, int x);
 
 private: