Skip to content

Commit dbeab2a

Browse files
committed
added missing documentation
1 parent 67043ac commit dbeab2a

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

src/FanController.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,9 @@ struct FanCurve {
8282
uint16_t rpms[FAN_CURVE_POINTS_NUM];
8383
};
8484

85+
/**
86+
* The abstract implementation of IFanController. This implementation handles the parsing and interpretation of incoming commands.
87+
*/
8588
class FanController : public IFanController {
8689
public:
8790
virtual void handleFanControl(const Command& command, const CorsairLightingProtocolResponse* response) override;

src/LEDController.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,15 @@ class LEDController : public ILEDController {
232232
*
233233
* @param channel the channel index
234234
* @param brightness the brightness in the range 0-255
235+
* @return true if the brightness was changed
235236
*/
236237
virtual bool setLEDBrightness(uint8_t channel, uint8_t brightness);
237238
/**
238239
* Set the type of LED chipset: WS2812B or UCS1903
239240
*
240241
* @param channel the channel index
241242
* @param ledPortType the port type
243+
* @return true if the port type was changed
242244
*/
243245
virtual bool setLEDPortType(uint8_t channel, PortType ledPortType);
244246
virtual void clearLEDColorValues(uint8_t channel) = 0;

src/TemperatureController.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
#define VOLTAGE_RAIL_5V 1
3333
#define VOLTAGE_RAIL_3V3 2
3434

35+
/**
36+
* The abstract implementation of the ITemperatureController. This implementation handles the commands parsing and processing.
37+
*/
3538
class TemperatureController : public ITemperatureController {
3639
public:
3740
virtual void handleTemperatureControl(const Command& command, const CorsairLightingProtocolResponse* response) override;

0 commit comments

Comments
 (0)