Updated comments in led device headers (#265)

This commit is contained in:
penfold42 2016-10-08 22:52:22 +11:00 committed by redPanther
parent 5aac2be702
commit b42f3453b4
8 changed files with 13 additions and 6 deletions

View File

@ -12,7 +12,7 @@
#include <leddevice/LedDevice.h> #include <leddevice/LedDevice.h>
/// ///
/// LedDevice implementation for a lightpack device (http://code.google.com/p/light-pack/) /// LedDevice implementation for a USBasp programmer with modified firmware (https://github.com/poljvd/hyperion-usbasp)
/// ///
class LedDeviceHyperionUsbasp : public LedDevice class LedDeviceHyperionUsbasp : public LedDevice
{ {

View File

@ -3,6 +3,10 @@
// Hyperion-Leddevice includes // Hyperion-Leddevice includes
#include <leddevice/LedDevice.h> #include <leddevice/LedDevice.h>
///
/// Implementation of the LedDevice interface for writing to pi-blaster based PWM LEDs
///
class LedDevicePiBlaster : public LedDevice class LedDevicePiBlaster : public LedDevice
{ {
public: public:

View File

@ -4,7 +4,7 @@
#include "ProviderSpi.h" #include "ProviderSpi.h"
/// ///
/// Implementation of the LedDevice interface for writing to Sk6801 led device. /// Implementation of the LedDevice interface for writing to Sk6801 led device via SPI.
/// ///
class LedDeviceSk6812SPI : public ProviderSpi class LedDeviceSk6812SPI : public ProviderSpi
{ {

View File

@ -6,7 +6,7 @@
#define TPM2_DEFAULT_PORT 65506 #define TPM2_DEFAULT_PORT 65506
/// ///
/// Implementation of the LedDevice interface for sending led colors via udp/E1.31 packets /// Implementation of the LedDevice interface for sending led colors via udp tpm2.net packets
/// ///
class LedDeviceTpm2net : public ProviderUdp class LedDeviceTpm2net : public ProviderUdp
{ {

View File

@ -127,7 +127,7 @@ struct dma_cb_t
}; };
/// ///
/// Implementation of the LedDevice interface for writing to Ws2801 led device. /// Implementation of the LedDevice interface for writing to Ws2812 led device using pwm.
/// ///
class LedDeviceWS2812b : public LedDevice class LedDeviceWS2812b : public LedDevice
{ {

View File

@ -3,6 +3,9 @@
#include <leddevice/LedDevice.h> #include <leddevice/LedDevice.h>
#include <ws2811.h> #include <ws2811.h>
///
/// Implementation of the LedDevice interface for writing to Ws2812 led device via pwm.
///
class LedDeviceWS281x : public LedDevice class LedDeviceWS281x : public LedDevice
{ {
public: public:

View File

@ -4,7 +4,7 @@
#include "ProviderSpi.h" #include "ProviderSpi.h"
/// ///
/// Implementation of the LedDevice interface for writing to Ws2801 led device. /// Implementation of the LedDevice interface for writing to Ws2812 led device via spi.
/// ///
class LedDeviceWs2812SPI : public ProviderSpi class LedDeviceWs2812SPI : public ProviderSpi
{ {

View File

@ -7,7 +7,7 @@
#include <utils/Logger.h> #include <utils/Logger.h>
/// ///
/// The ProviderUdp implements an abstract base-class for LedDevices using the SPI-device. /// The ProviderUdp implements an abstract base-class for LedDevices using UDP packets.
/// ///
class ProviderUdp : public LedDevice class ProviderUdp : public LedDevice
{ {