aland/quickshell
1
0
Fork 0
mirror of https://git.outfoxxed.me/quickshell/quickshell.git synced 2026-02-23 03:33:57 +11:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: use new member reference shorthand

Browse source
This commit is contained in:
outfoxxed 2024-07-21 17:41:49 -07:00
parent dfcf533424
commit a9e4720fae
No known key found for this signature in database
GPG key ID: 4C88A185FB89301E
35 changed files with 182 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/services/upower/core.hpp
View file

@ -55,7 +55,7 @@ class UPowerQml: public QObject {
QML_SINGLETON;
/// UPower's DisplayDevice for your system. Can be `null`.
///
/// This is an aggregate device and not a physical one, meaning you will not find it in `devices`.
/// This is an aggregate device and not a physical one, meaning you will not find it in @@devices.
/// It is typically the device that is used for displaying information in desktop environments.
Q_PROPERTY(UPowerDevice* displayDevice READ displayDevice NOTIFY displayDeviceChanged);
/// All connected UPower devices.

8
src/services/upower/device.hpp
View file

@ -12,6 +12,8 @@
namespace qs::service::upower {
///! Power state of a UPower device.
/// See @@UPowerDevice.state.
class UPowerDeviceState: public QObject {
Q_OBJECT;
QML_ELEMENT;
@ -34,6 +36,8 @@ public:
Q_INVOKABLE static QString toString(UPowerDeviceState::Enum status);
};
///! Type of a UPower device.
/// See @@UPowerDevice.type.
class UPowerDeviceType: public QObject {
Q_OBJECT;
QML_ELEMENT;
@ -100,7 +104,7 @@ class UPowerDevice: public QObject {
Q_PROPERTY(qreal timeToFull READ timeToFull NOTIFY timeToFullChanged);
/// Current charge level as a percentage.
///
/// This would be equivalent to `energy / energyCapacity`.
/// This would be equivalent to @@energy / @@energyCapacity.
Q_PROPERTY(qreal percentage READ percentage NOTIFY percentageChanged);
/// If the power source is present in the bay or slot, useful for hot-removable batteries.
///
@ -115,7 +119,7 @@ class UPowerDevice: public QObject {
Q_PROPERTY(QString iconName READ iconName NOTIFY iconNameChanged);
/// If the device is a laptop battery or not. Use this to check if your device is a valid battery.
///
/// This will be equivalent to `type == Battery && powerSupply == true`.
/// This will be equivalent to @@type == Battery && @@powerSupply == true.
Q_PROPERTY(bool isLaptopBattery READ isLaptopBattery NOTIFY isLaptopBatteryChanged);
/// Native path of the device specific to your OS.
Q_PROPERTY(QString nativePath READ nativePath NOTIFY nativePathChanged);