Skip to content

Commit

Permalink
[qusbmode] Clarify commenting about "event" vs "state" USB modes
Browse files Browse the repository at this point in the history
There are "modes" that signify actual mode changes and then there
are "modes" that signify transient events such as connect/disconnect.
The former ought to be called "states" and latter "events, but the
header uses moniker "state" for "events."

Explicitly mention "state" or "event" as appropriate.

Signed-off-by: Simo Piiroinen <simo.piiroinen@jollamobile.com>
  • Loading branch information
spiiroin committed Feb 18, 2019
1 parent 9d1f3a0 commit 62d9487
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/qusbmode.h
Expand Up @@ -42,7 +42,7 @@ class QUSBMODED_EXPORT QUsbMode : public QObject
{
Q_OBJECT

// States (from usb_moded-dbus.h)
// Transient Modes / "Events" (from usb_moded-dbus.h)
Q_PROPERTY(QString USB_CONNECTED READ USB_CONNECTED CONSTANT)
Q_PROPERTY(QString DATA_IN_USE READ DATA_IN_USE CONSTANT)
Q_PROPERTY(QString USB_DISCONNECTED READ USB_DISCONNECTED CONSTANT)
Expand All @@ -53,7 +53,7 @@ class QUSBMODED_EXPORT QUsbMode : public QObject
Q_PROPERTY(QString CHARGER_CONNECTED READ CHARGER_CONNECTED CONSTANT)
Q_PROPERTY(QString CHARGER_DISCONNECTED READ CHARGER_DISCONNECTED CONSTANT)

// Modes (from usb_moded-modes.h)
// Persistent Modes / "States" (from usb_moded-modes.h)
Q_PROPERTY(QString MODE_UNDEFINED READ MODE_UNDEFINED CONSTANT)
Q_PROPERTY(QString MODE_ASK READ MODE_ASK CONSTANT)
Q_PROPERTY(QString MODE_MASS_STORAGE READ MODE_MASS_STORAGE CONSTANT)
Expand All @@ -72,7 +72,7 @@ class QUSBMODED_EXPORT QUsbMode : public QObject
public:
class Mode {
public:
// States (from usb_moded-dbus.h)
// Transient Modes / "Events" (from usb_moded-dbus.h)
static const QString Connected;
static const QString DataInUse;
static const QString Disconnected;
Expand All @@ -83,7 +83,7 @@ class QUSBMODED_EXPORT QUsbMode : public QObject
static const QString ChargerConnected;
static const QString ChargerDisconnected;

// Modes (from usb_moded-modes.h)
// Persistent Modes / "States" (from usb_moded-modes.h)
static const QString Undefined;
static const QString Ask;
static const QString MassStorage;
Expand Down

0 comments on commit 62d9487

Please sign in to comment.