fdo-mirrors/upower
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/upower/upower.git synced 2025-12-20 04:20:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Better documentation for the BatteryLevel prop

Browse source 
https://bugs.freedesktop.org/show_bug.cgi?id=103361
This commit is contained in:
Bastien Nocera 2017-10-19 17:19:15 +02:00
parent 296f5855d0
commit b9aaa05bc6
2 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
dbus/org.freedesktop.UPower.Device.xml
View file

@ -529,6 +529,10 @@ method return sender=:1.386 -> dest=:1.477 reply_serial=2
<doc:ref type="property" to="Source:Type">type</doc:ref>
has the value "battery".
</doc:para>
<doc:para>
The percentage will be an approximation if the <doc:ref type="property" to="BatteryLevel">battery level</doc:ref>
is set to something other than None. The percentage is kept for compatibility reasons.
</doc:para>
</doc:description>
</doc:doc>
</property>
@ -707,7 +711,8 @@ method return sender=:1.386 -> dest=:1.477 reply_serial=2
<doc:doc>
<doc:description>
<doc:para>
Level of the battery:
The level of the battery for devices which do not report a percentage but rather a coarse battery level. If the value
is None, then the device does not support coarse battery reporting, and the percentage should be used instead.
</doc:para>
<doc:list>
<doc:item>

12
libupower-glib/up-types.h
View file

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