mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
Fixed doxygen warnings
This commit is contained in:
@@ -47,6 +47,7 @@ public:
|
||||
///
|
||||
/// Determines the led colors of the image in the buffer.
|
||||
///
|
||||
/// @param[in] image The image to translate to led values
|
||||
/// @param[out] ledColors The color value per led
|
||||
///
|
||||
void process(const RgbImage& image, std::vector<RgbColor>& ledColors);
|
||||
|
@@ -13,18 +13,20 @@ class LedDevice
|
||||
{
|
||||
public:
|
||||
|
||||
/**
|
||||
* Empty virtual destructor for pure virtual base class
|
||||
*/
|
||||
///
|
||||
/// Empty virtual destructor for pure virtual base class
|
||||
///
|
||||
virtual ~LedDevice()
|
||||
{
|
||||
// empty
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the RGB-Color values to the leds.
|
||||
*
|
||||
* @param[in] ledValues The RGB-color per led
|
||||
*/
|
||||
///
|
||||
/// Writes the RGB-Color values to the leds.
|
||||
///
|
||||
/// @param[in] ledValues The RGB-color per led
|
||||
///
|
||||
/// @return Zero on success else negative
|
||||
///
|
||||
virtual int write(const std::vector<RgbColor>& ledValues) = 0;
|
||||
};
|
||||
|
@@ -15,7 +15,7 @@ namespace Json { class Value; }
|
||||
///
|
||||
/// The Led structure contains the definition of the image portion used to determine a single led's
|
||||
/// color.
|
||||
/// <pre>
|
||||
/// @verbatim
|
||||
/// |--------------------image--|
|
||||
/// | minX maxX |
|
||||
/// | |-----|minY |
|
||||
@@ -25,7 +25,7 @@ namespace Json { class Value; }
|
||||
/// | |
|
||||
/// | |
|
||||
/// |---------------------------|
|
||||
/// <endpre>
|
||||
/// @endverbatim
|
||||
///
|
||||
struct Led
|
||||
{
|
||||
|
Reference in New Issue
Block a user