Diff: TPixy.h

Revision:

2:fa582d9d91b5

Parent:

0:ef0e3c67dc5b

Child:

3:66df7d295245

--- a/TPixy.h	Mon Mar 14 17:42:33 2016 +0000
+++ b/TPixy.h	Mon Mar 14 17:50:40 2016 +0000
@@ -58,15 +58,28 @@
     uint16_t angle;
 };
 
+/** The superclass handler for the Pixy camera from a given connection handler (SPI, I2C, etc)
+  * Used for instantiating a Pixy object that interfaces via an abtritrary connection handler
+  */
 template <class TPixyInterface> class TPixy
 {
 public:
     Serial* serial;
     Block *blocks;
     
+    /** Constructor for the TPixy object
+      * Creates a TPixy object with a given connection handler
+      * @param TPixyInterface* type the pointer to the interface connection handler
+      * @param Serial* serialOut the optional serial output pointer to print out Pixy camera data
+      * @param int arg an optional integer argument used for custom implementations of the Pixy library
+      */
     TPixy(TPixyInterface* type, Serial* serialOut = NULL, uint16_t arg = PIXY_DEFAULT_ARGVAL);
     ~TPixy();
 
+    /** Printer for TPixy to print block information
+      * Prints the block out to the given serial port
+      * Block &ref the block to print
+      */
     void printBlock(Block &);
     uint16_t getBlocks(uint16_t maxBlocks = 1000);
     int8_t setServos(uint16_t s0, uint16_t s1);