DrathOrg/libratbag-plus
1
0
Fork 0
forked from drath/libratbag
Code Pull Requests Activity

enums.h: few doc fixups

Browse Source 
Replacing the doctext where they should be in enum ratbag_led_mode.

Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>
This commit is contained in:
Benjamin Tissoires
2017-10-13 10:02:11 +02:00
committed by Peter Hutterer
parent 1e35b2ace6
commit f56df6b1d0
1 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/libratbag-enums.h
View File

@@ -80,6 +80,7 @@ enum ratbag_error_code {
*/
enum ratbag_device_capability {
RATBAG_DEVICE_CAP_NONE = 0,
/**
* The device has the capability to query the current hardware
* configuration. If this capability is missing, libratbag cannot
@@ -173,6 +174,7 @@ enum ratbag_device_capability {
*/
enum ratbag_profile_capability {
RATBAG_PROFILE_CAP_NONE = 0,
/**
* The device has the capability to write a name to a profile
* and store it in its flash.
@@ -318,18 +320,28 @@ enum ratbag_button_action_special {
/**
* @ingroup enums
*
* RATBAG_LED_OFF - led is now off,
* RATBAG_LED_ON - led is on with static color,
* RATBAG_LED_CYCLE - led is cycling between all colors.
* RATBAG_LED_BREATHING - led is pulsating with static color
*
* Each LED mode has different properties, e.g. the brightness and rate are only
* available in modes @ref RATBAG_LED_CYCLE and @ref RATBAG_LED_BREATHING modes
*/
enum ratbag_led_mode {
/**
* led is now off
*/
RATBAG_LED_OFF = 0,
/**
* led is on with static color
*/
RATBAG_LED_ON,
/**
* led is cycling between all colors
*/
RATBAG_LED_CYCLE,
/**
* led is pulsating with static color
*/
RATBAG_LED_BREATHING,
};
/**