diff options
| author | Bastien Nocera <hadess@hadess.net> | 2017-10-19 17:19:15 +0200 |
|---|---|---|
| committer | Bastien Nocera <hadess@hadess.net> | 2017-10-31 17:45:18 +0100 |
| commit | b9aaa05bc6bc5d40bd95b4f2fc7ef0d121879373 (patch) | |
| tree | bf379fc8e132a4b9004602cd65817b6c20c85643 /libupower-glib | |
| parent | 296f5855d0c328d86893075b05acaa546ce52355 (diff) | |
| download | upower-b9aaa05bc6bc5d40bd95b4f2fc7ef0d121879373.tar.gz | |
docs: Better documentation for the BatteryLevel prop
https://bugs.freedesktop.org/show_bug.cgi?id=103361
Diffstat (limited to 'libupower-glib')
| -rw-r--r-- | libupower-glib/up-types.h | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/libupower-glib/up-types.h b/libupower-glib/up-types.h index 5ba87ac..079bccd 100644 --- a/libupower-glib/up-types.h +++ b/libupower-glib/up-types.h @@ -87,8 +87,16 @@ typedef enum { /** * UpDeviceLevel: * - * The level of a battery. Some values are only relevant to the WarningLevel - * property, some others to the BatteryLevel property. + * The level of a battery. Only values up to, and including + * %UP_DEVICE_LEVEL_ACTION are relevant for the #WarningLevel. + * The #BatteryLevel only uses the following values: + * - %UP_DEVICE_LEVEL_UNKNOWN + * - %UP_DEVICE_LEVEL_NONE + * - %UP_DEVICE_LEVEL_LOW + * - %UP_DEVICE_LEVEL_CRITICAL + * - %UP_DEVICE_LEVEL_NORMAL + * - %UP_DEVICE_LEVEL_HIGH + * - %UP_DEVICE_LEVEL_FULL **/ typedef enum { UP_DEVICE_LEVEL_UNKNOWN, |