more lite doxy

adafruit · Dec 29, 2019 · 83a6854 · 83a6854
1 parent 60f02da
commit 83a6854
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Adafruit_BMP280.cpp b/Adafruit_BMP280.cpp
@@ -477,6 +477,7 @@ void Adafruit_BMP280_Temp::getSensor(sensor_t *sensor) {
 /*!
     @brief  Gets the temperature as a standard sensor event
     @param  event Sensor event object that will be populated
+    @returns True
 */
 /**************************************************************************/
 bool Adafruit_BMP280_Temp::getEvent(sensors_event_t *event) {
@@ -516,6 +517,7 @@ void Adafruit_BMP280_Pressure::getSensor(sensor_t *sensor) {
 /*!
     @brief  Gets the pressure as a standard sensor event
     @param  event Sensor event object that will be populated
+    @returns True
 */
 /**************************************************************************/
 bool Adafruit_BMP280_Pressure::getEvent(sensors_event_t *event) {

diff --git a/Adafruit_BMP280.h b/Adafruit_BMP280.h
@@ -90,6 +90,8 @@ class Adafruit_BMP280;
 /** Adafruit Unified Sensor interface for temperature component of BMP280 */
 class Adafruit_BMP280_Temp : public Adafruit_Sensor {
 public:
+  /** @brief Create an Adafruit_Sensor compatible object for the temp sensor
+      @param parent A pointer to the BMP280 class */
   Adafruit_BMP280_Temp(Adafruit_BMP280 *parent) { _theBMP280 = parent; }
   bool getEvent(sensors_event_t *);
   void getSensor(sensor_t *);
@@ -102,6 +104,8 @@ class Adafruit_BMP280_Temp : public Adafruit_Sensor {
 /** Adafruit Unified Sensor interface for pressure component of BMP280 */
 class Adafruit_BMP280_Pressure : public Adafruit_Sensor {
 public:
+  /** @brief Create an Adafruit_Sensor compatible object for the pressure sensor
+      @param parent A pointer to the BMP280 class */
   Adafruit_BMP280_Pressure(Adafruit_BMP280 *parent) { _theBMP280 = parent; }
   bool getEvent(sensors_event_t *);
   void getSensor(sensor_t *);