Correct the calibateTemperature function's documentation

pcolby · Jan 8, 2024 · 3471a91 · 3471a91
1 parent 1fd9a3c
commit 3471a91
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/lib/calibrationservice.cpp b/src/lib/calibrationservice.cpp
@@ -61,11 +61,11 @@ bool CalibrationService::readCharacteristics()
 }
 
 /*!
- * Set's the Pokit device's name to \a name.
+ * Calibrates the Pokit device's temperature to \a ambientTemperature.
  *
  * Returns `true` if the write request was successfully queued, `false` otherwise.
  *
- * Emits deviceNameWritten() if/when the \a name has been set.
+ * Emits temperatureCalibrated() if/when the \a name has been set.
  */
 bool CalibrationService::calibrateTemperature(const float ambientTemperature)
 {