Qisi Wang / ADJDs311

A library for the Avago ADJD-S311-CR999 Color Light Sensor

Dependents:   ADJD-S311_HelloWorld

Files at this revision

API Documentation at this revision

Revision 2:5d0bc4df0701, committed 2014-03-24

Comitter:
CheeseW
Date:
Mon Mar 24 05:27:07 2014 +0000
Parent:
1:fc17a6ccc6f0
Commit message:
Add class documentation\

Changed in this revision

ADJDs311.h Show annotated file Show diff for this revision Revisions of this file 
diff -r fc17a6ccc6f0 -r 5d0bc4df0701 ADJDs311.h
--- a/ADJDs311.h	Mon Mar 24 05:23:03 2014 +0000
+++ b/ADJDs311.h	Mon Mar 24 05:27:07 2014 +0000
@@ -39,6 +39,9 @@
 #define OFFSET_BLUE     0x4A
 #define OFFSET_CLEAR    0x4B
 
+/**
+ * A structure contain info about the red, green, blue and clear channel
+ */
 struct RGBC{
     int red;
     int blue;
@@ -46,11 +49,14 @@
     int clear;
 };
 
-
+/**
+ * A ADJD-S311 color sensor class 
+ */
 class ADJDs311{
  public:
 
-/** Create a color sensor interface
+/** 
+ * Create a color sensor interface
  *
  * @param sda       Pin connected to sda of color sensor
  * @param scl       Pin connected to scl of color sensor