Fixed doxygen warnings

This commit is contained in:
T. van der Zwan
2013-09-09 20:35:28 +00:00
parent a6c0f06b44
commit ecdd7775c5
14 changed files with 205 additions and 35 deletions

View File

@@ -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);

View File

@@ -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;
};

View File

@@ -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
{