Correct some minor spelling errors

pcolby · pcolby · commit eac78fe25ab8 · 2025-05-06T22:35:59.000+10:00
diff --git a/README.md b/README.md
@@ -231,7 +231,7 @@ cmake --build <tmp-build-dir> --target doc doc-internal
 # ls <tmp-build-dir>/doc/internal  # Internal developer documentation
 ```
 
-These are regularly published to Github Pages via Github Actions:
+These are regularly published to GitHub Pages via GitHub Actions:
 
 * [public end-user docs](https://pcolby.github.io/dokit/main/doc/index.html)
 * [internal dev docs](https://pcolby.github.io/dokit/main/int/index.html)
diff --git a/include/qtpokit/calibrationservice.h b/include/qtpokit/calibrationservice.h
@@ -29,13 +29,13 @@ class QTPOKIT_EXPORT CalibrationService : public AbstractPokitService
 
     /// Characteristics available via the `Calibration` service.
     struct QTPOKIT_EXPORT CharacteristicUuids {
-        /// UUID of the `Calibration` service's `Temperature` characterstic.
+        /// UUID of the `Calibration` service's `Temperature` characteristic.
         static inline const QBluetoothUuid temperature { QStringLiteral("0cd0f713-f5aa-4572-9e23-f8049f6bcaaa") };
 
-        /// \todo UUID of the `Calibration` service's (undocumented) `Get Parameter` characterstic.
+        /// \todo UUID of the `Calibration` service's (undocumented) `Get Parameter` characteristic.
         static inline const QBluetoothUuid getParam { QStringLiteral("b6728f91-409c-4d6c-864e-272a6a7a0204") };
 
-        /// \todo UUID of the `Calibration` service's (undocumented) `Set Parameter` characterstic.
+        /// \todo UUID of the `Calibration` service's (undocumented) `Set Parameter` characteristic.
         static inline const QBluetoothUuid setParam { QStringLiteral("5588e47b-cb81-4f7b-acc4-6029a3f39f72") };
     };
 
diff --git a/include/qtpokit/dataloggerservice.h b/include/qtpokit/dataloggerservice.h
@@ -29,13 +29,13 @@ class QTPOKIT_EXPORT DataLoggerService : public AbstractPokitService
 
     /// Characteristics available via the `DataLogger` service.
     struct QTPOKIT_EXPORT CharacteristicUuids {
-        /// UUID of the `DataLogger` service's `Settings` characterstic.
+        /// UUID of the `DataLogger` service's `Settings` characteristic.
         static inline const QBluetoothUuid settings { QStringLiteral("5f97c62b-a83b-46c6-b9cd-cac59e130a78") };
 
-        /// UUID of the `DataLogger` service's `Metadata` characterstic.
+        /// UUID of the `DataLogger` service's `Metadata` characteristic.
         static inline const QBluetoothUuid metadata { QStringLiteral("9acada2e-3936-430b-a8f7-da407d97ca6e") };
 
-        /// UUID of the `DataLogger` service's `Reading` characterstic.
+        /// UUID of the `DataLogger` service's `Reading` characteristic.
         static inline const QBluetoothUuid reading  { QStringLiteral("3c669dab-fc86-411c-9498-4f9415049cc0") };
     };
 
@@ -62,7 +62,7 @@ class QTPOKIT_EXPORT DataLoggerService : public AbstractPokitService
     static quint32 maxValue(const PokitProduct product, const quint8 range, const Mode mode);
     quint32 maxValue(const quint8 range, const Mode mode) const;
 
-    /// Attributes included in the `Settings` characterstic.
+    /// Attributes included in the `Settings` characteristic.
     struct Settings {
         Command command;        ///< Custom operation request.
         quint16 arguments;      ///< Reserved to used along with #command in future.
@@ -80,7 +80,7 @@ class QTPOKIT_EXPORT DataLoggerService : public AbstractPokitService
         Error      = 255  ///< An error has occurred.
     };
 
-    /// Attributes included in the `Metadata` characterstic.
+    /// Attributes included in the `Metadata` characteristic.
     struct Metadata {
         LoggerStatus status;     ///< Current data logger status.
         float scale;             ///< Scale to apply to read samples.
diff --git a/include/qtpokit/deviceinfoservice.h b/include/qtpokit/deviceinfoservice.h
@@ -30,27 +30,27 @@ class QTPOKIT_EXPORT DeviceInfoService : public AbstractPokitService
 
     /// Characteristics available via the `Device Info` service.
     struct QTPOKIT_EXPORT CharacteristicUuids {
-        /// UUID of the `Device Info` service's `Manufacturer Name String` characterstic.
+        /// UUID of the `Device Info` service's `Manufacturer Name String` characteristic.
         static inline const QBluetoothUuid manufacturerName
             { QBluetoothUuid::CharacteristicType::ManufacturerNameString }; // 0x2a29
 
-        /// UUID of the `Device Info` service's `Model Number String` characterstic.
+        /// UUID of the `Device Info` service's `Model Number String` characteristic.
         static inline const QBluetoothUuid modelNumber
             { QBluetoothUuid::CharacteristicType::ModelNumberString }; // 0x2a24
 
-        /// UUID of the `Device Info` service's `Firmware Revision String` characterstic.
+        /// UUID of the `Device Info` service's `Firmware Revision String` characteristic.
         static inline const QBluetoothUuid firmwareRevision
             { QBluetoothUuid::CharacteristicType::FirmwareRevisionString }; // 0x2a26
 
-        /// UUID of the `Device Info` service's `Hardware Revision String` characterstic.
+        /// UUID of the `Device Info` service's `Hardware Revision String` characteristic.
         static inline const QBluetoothUuid hardwareRevision
             { QBluetoothUuid::CharacteristicType::HardwareRevisionString }; // 0x2a27
 
-        /// UUID of the `Device Info` service's `Software Revision String` characterstic.
+        /// UUID of the `Device Info` service's `Software Revision String` characteristic.
         static inline const QBluetoothUuid softwareRevision
             { QBluetoothUuid::CharacteristicType::SoftwareRevisionString }; // 0x2a28
 
-        /// UUID of the `Device Info` service's `Serial Number String` characterstic.
+        /// UUID of the `Device Info` service's `Serial Number String` characteristic.
         static inline const QBluetoothUuid serialNumber
             { QBluetoothUuid::CharacteristicType::SerialNumberString }; // 0x2a25
     };
diff --git a/include/qtpokit/dsoservice.h b/include/qtpokit/dsoservice.h
@@ -30,13 +30,13 @@ class QTPOKIT_EXPORT DsoService : public AbstractPokitService
 
     /// Characteristics available via the `DSO` service.
     struct QTPOKIT_EXPORT CharacteristicUuids {
-        /// UUID of the `DSO` service's `Settings` characterstic.
+        /// UUID of the `DSO` service's `Settings` characteristic.
         static inline const QBluetoothUuid settings { QStringLiteral("a81af1b6-b8b3-4244-8859-3da368d2be39") };
 
-        /// UUID of the `DSO` service's `Metadata` characterstic.
+        /// UUID of the `DSO` service's `Metadata` characteristic.
         static inline const QBluetoothUuid metadata { QStringLiteral("970f00ba-f46f-4825-96a8-153a5cd0cda9") };
 
-        /// UUID of the `DSO` service's `Reading` characterstic.
+        /// UUID of the `DSO` service's `Reading` characteristic.
         static inline const QBluetoothUuid reading  { QStringLiteral("98e14f8e-536e-4f24-b4f4-1debfed0a99e") };
     };
 
@@ -63,7 +63,7 @@ class QTPOKIT_EXPORT DsoService : public AbstractPokitService
     static quint32 maxValue(const PokitProduct product, const quint8 range, const Mode mode);
     quint32 maxValue(const quint8 range, const Mode mode) const;
 
-    /// Attributes included in the `Settings` characterstic.
+    /// Attributes included in the `Settings` characteristic.
     struct Settings {
         Command command;         ///< Custom operation request.
         float triggerLevel;      ///< Trigger threshold level in Volts or Amps, depending on #mode.
@@ -80,7 +80,7 @@ class QTPOKIT_EXPORT DsoService : public AbstractPokitService
         Error      = 255 ///< An error has occurred.
     };
 
-    /// Attributes included in the `Metadata` characterstic.
+    /// Attributes included in the `Metadata` characteristic.
     struct Metadata {
         DsoStatus status;        ///< Current DSO status.
         float scale;             ///< Scale to apply to read samples.
diff --git a/include/qtpokit/multimeterservice.h b/include/qtpokit/multimeterservice.h
@@ -29,10 +29,10 @@ class QTPOKIT_EXPORT MultimeterService : public AbstractPokitService
 
     /// Characteristics available via the `Multimeter` service.
     struct QTPOKIT_EXPORT CharacteristicUuids {
-        /// UUID of the `Multimeter` service's `Settings` characterstic.
+        /// UUID of the `Multimeter` service's `Settings` characteristic.
         static inline const QBluetoothUuid settings { QStringLiteral("53dc9a7a-bc19-4280-b76b-002d0e23b078") };
 
-        /// UUID of the `Multimeter` service's `Reading` characterstic.
+        /// UUID of the `Multimeter` service's `Reading` characteristic.
         static inline const QBluetoothUuid reading  { QStringLiteral("047d3559-8bee-423a-b229-4417fa603b90") };
     };
 
@@ -57,7 +57,7 @@ class QTPOKIT_EXPORT MultimeterService : public AbstractPokitService
     static quint32 maxValue(const PokitProduct product, const quint8 range, const Mode mode);
     quint32 maxValue(const quint8 range, const Mode mode) const;
 
-    /// Attributes included in the `Settings` characterstic.
+    /// Attributes included in the `Settings` characteristic.
     struct Settings {
         Mode mode;              ///< Desired operation mode.
         quint8 range;           ///< Desired range.
@@ -74,7 +74,7 @@ class QTPOKIT_EXPORT MultimeterService : public AbstractPokitService
         Error        = 255 ///< Error (all modes).
     };
 
-    /// Attributes included in the `Reading` characterstic.
+    /// Attributes included in the `Reading` characteristic.
     struct Reading {
         MeterStatus status; ///< Current multimeter status.
         float value;        ///< Last acquired value.
diff --git a/include/qtpokit/statusservice.h b/include/qtpokit/statusservice.h
@@ -35,22 +35,22 @@ class QTPOKIT_EXPORT StatusService : public AbstractPokitService
 
     /// Characteristics available via the `Pokit Status` service.
     struct QTPOKIT_EXPORT CharacteristicUuids {
-        /// UUID of the `Pokit Status` service's `Device Characteristics` characterstic.
+        /// UUID of the `Pokit Status` service's `Device Characteristics` characteristic.
         static inline const QBluetoothUuid deviceCharacteristics  { QStringLiteral("6974f5e5-0e54-45c3-97dd-29e4b5fb0849") };
 
-        /// UUID of the `Pokit Status` service's `Status` characterstic.
+        /// UUID of the `Pokit Status` service's `Status` characteristic.
         static inline const QBluetoothUuid status { QStringLiteral("3dba36e1-6120-4706-8dfd-ed9c16e569b6") };
 
-        /// UUID of the `Pokit Status` service's `Device Name` characterstic.
+        /// UUID of the `Pokit Status` service's `Device Name` characteristic.
         static inline const QBluetoothUuid name { QStringLiteral("7f0375de-077e-4555-8f78-800494509cc3") };
 
-        /// UUID of the `Pokit Status` service's `Flash LED` characterstic.
+        /// UUID of the `Pokit Status` service's `Flash LED` characteristic.
         static inline const QBluetoothUuid flashLed { QStringLiteral("ec9bb1f3-05a9-4277-8dd0-60a7896f0d6e") };
 
-        /// UUID of the `Pokit Status` service's (undocumented) `Torch` characterstic.
+        /// UUID of the `Pokit Status` service's (undocumented) `Torch` characteristic.
         static inline const QBluetoothUuid torch { QStringLiteral("aaf3f6d5-43d4-4a83-9510-dff3d858d4cc") };
 
-        /// UUID of the `Pokit Status` service's (undocumented) `Button Press` characterstic.
+        /// UUID of the `Pokit Status` service's (undocumented) `Button Press` characteristic.
         static inline const QBluetoothUuid buttonPress { QStringLiteral("8fe5b5a9-b5b4-4a7b-8ff2-87224b970f89") };
 
         /*!
@@ -63,7 +63,7 @@ class QTPOKIT_EXPORT StatusService : public AbstractPokitService
          */
     };
 
-    /// Attributes included in the `Device Characteristics` characterstic.
+    /// Attributes included in the `Device Characteristics` characteristic.
     struct DeviceCharacteristics {
         QVersionNumber firmwareVersion; ///< Device's major and minor firmware version.
         quint16 maximumVoltage;         ///< Device's maximum input voltage.
@@ -108,13 +108,13 @@ class QTPOKIT_EXPORT StatusService : public AbstractPokitService
 
     /// Values supported by the (undocumented) `Charging Statue` attribute of the `Status` characteristic.
     enum class ChargingStatus : quint8 {
-        Discharging = 0, ///< Battery is dischargin.
+        Discharging = 0, ///< Battery is discharging.
         Charging    = 1, ///< Battery is being charged.
         Charged     = 2, ///< Battery is fully charged.
     };
     static QString toString(const StatusService::ChargingStatus &status);
 
-    /// Attributes included in the `Status` characterstic.
+    /// Attributes included in the `Status` characteristic.
     struct Status {
         DeviceStatus deviceStatus;   ///< Current Pokit device status.
         float batteryVoltage;        ///< Current battery voltage level.
diff --git a/test/unit/lib/testcalibrationservice.cpp b/test/unit/lib/testcalibrationservice.cpp
@@ -20,7 +20,7 @@ void TestCalibrationService::readCharacteristics()
         QSKIP("BLE controller operations hang on GitHub Actions's macOS 14 runners");
     }
 
-    // readCharacteristics always returns true, since the service has no readable characterstics.
+    // readCharacteristics always returns true, since the service has no readable characteristics.
     CalibrationService service(QLowEnergyController::createCentral(QBluetoothDeviceInfo()));
     QVERIFY(service.readCharacteristics());
 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ void TestCalibrationService::readCharacteristics()`
`20`	`20`	`QSKIP("BLE controller operations hang on GitHub Actions's macOS 14 runners");`
`21`	`21`	`}`
`22`	`22`
`23`		`- // readCharacteristics always returns true, since the service has no readable characterstics.`
	`23`	`+ // readCharacteristics always returns true, since the service has no readable characteristics.`
`24`	`24`	`CalibrationService service(QLowEnergyController::createCentral(QBluetoothDeviceInfo()));`
`25`	`25`	`QVERIFY(service.readCharacteristics());`
`26`	`26`	`}`