Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/FastLED/FastLED.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanielgarcia@gmail.com <danielgarcia@gmail.com@4ad4ec5c-605d-bd5c-5796-512c9b60011b>2013-02-19 06:45:04 +0400
committerdanielgarcia@gmail.com <danielgarcia@gmail.com@4ad4ec5c-605d-bd5c-5796-512c9b60011b>2013-02-19 06:45:04 +0400
commit096e4c3c326341cb3abfb2f07aa5272ff3bcdf13 (patch)
treee61988abd69538c89b0516c73874e37e9cd59c45 /controller.h
parent6fbfd3f17e67dcb8164486b6c06985a3a3cc0732 (diff)
Add more documentation to the library and some slight code cleanup
Diffstat (limited to 'controller.h')
-rw-r--r--controller.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/controller.h b/controller.h
index 5916042f..0dbd0d12 100644
--- a/controller.h
+++ b/controller.h
@@ -9,7 +9,10 @@
//
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-
+/// Base definition for an LED controller. Pretty much the methods that every LED controller object will make available.
+/// Note that the showARGB method is not impelemented for all controllers yet. Note also the methods for eventual checking
+/// of background writing of data (I'm looking at you, teensy 3.0 DMA controller!). If you want to pass LED controllers around
+/// to methods, make them references to this type, keeps your code saner.
class CLEDController {
public:
// initialize the LED controller