Merge pull request #553 from UncleRus/bugfix/doxygen-docs

UncleRus · web-flow · commit 7003f675497b · 2023-08-05T19:02:39.000+05:00
bugfix: fix doxygen comments and docs, update doxygen config
diff --git a/components/ads130e08/ads130e08.h b/components/ads130e08/ads130e08.h
@@ -352,7 +352,7 @@ esp_err_t ads130e08_set_channel_config(ads130e08_t *dev, ads130e08_channel_t cha
  *
  * @param dev         Pointer to device descriptor
  * @param channel     Channel
- * @param[out]config  Channel configuration
+ * @param[out] config Channel configuration
  * @return `ESP_OK` on success
  */
 esp_err_t ads130e08_get_channel_config(ads130e08_t *dev, ads130e08_channel_t channel,
@@ -417,4 +417,4 @@ esp_err_t ads130e08_detect_fault_auto(ads130e08_t *dev, uint8_t *fault_statp, ui
 
 /**@}*/
 
-#endif /* __ADS130E08_H__ */
+#endif /* __ADS130E08_H__ */
diff --git a/components/dps310/include/dps310.h b/components/dps310/include/dps310.h
@@ -21,7 +21,7 @@
  * @defgroup dps310 dps310
  * @{
  *
- * ESP-IDF driver for DPS310 barometric pressure sensor. Sponsored by @beriberikix.
+ * ESP-IDF driver for DPS310 barometric pressure sensor. Sponsored by beriberikix.
  *
  * DPS310 supports I2C and SPI (3-wires and 4-wires) as digital interface. The
  * driver currently supports:
diff --git a/components/ht16k33/ht16k33.h b/components/ht16k33/ht16k33.h
@@ -109,6 +109,7 @@ esp_err_t ht16k33_display_setup(i2c_dev_t *dev, uint8_t on_flag,
 /**
  * @brief Write whole HT16K33_RAM_SIZE_BYTES into RAM.
  *
+ * @param dev I2C device descriptor
  * @param data Bytes to write.
  * @return ESP_OK to indicate success
  */
diff --git a/components/sgm58031/sgm58031.h b/components/sgm58031/sgm58031.h
@@ -197,18 +197,6 @@ esp_err_t sgm58031_start_conversion(i2c_dev_t *dev);
  */
 esp_err_t sgm58031_get_value(i2c_dev_t *dev, int16_t *value);
 
-/**
- * @brief Read last conversion result
- *
- * @param[in] dev Device descriptor
- * @param[out] value Last conversion result
- * @return
- *  - `ESP_OK` on success
- *  - `ESP_INVALID_ARG` if dev or value are NULL
- *  - `ESP_FAIL` otherwise
- */
-esp_err_t sgm58031_get_value(i2c_dev_t *dev, int16_t *value);
-
 /**
  * @brief Read the programmable gain amplifier configuration
  *
diff --git a/components/si7021/si7021.h b/components/si7021/si7021.h
@@ -239,7 +239,7 @@ esp_err_t si7021_get_device_id(i2c_dev_t *dev, si7021_device_id_t *id);
  *  - SI7021
  *
  * @param dev       Device descriptor
- * @param[out] id   Device revision
+ * @param[out] rev  Device revision
  * @return `ESP_OK` on success
  */
 esp_err_t si7021_get_device_revision(i2c_dev_t *dev, uint8_t *rev);
diff --git a/docs/doxygen.conf b/docs/doxygen.conf
diff --git a/docs/source/groups/sgm58031.rst b/docs/source/groups/sgm58031.rst
@@ -1,4 +1,4 @@
-. _sgm58031:
+.. _sgm58031:
 
 sgm58031 - Driver for SGM58031 16-bit ADC
 =======================================================================

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`* @defgroup dps310 dps310`
`22`	`22`	`* @{`
`23`	`23`	`*`
`24`		`- * ESP-IDF driver for DPS310 barometric pressure sensor. Sponsored by @beriberikix.`
	`24`	`+ * ESP-IDF driver for DPS310 barometric pressure sensor. Sponsored by beriberikix.`
`25`	`25`	`*`
`26`	`26`	`* DPS310 supports I2C and SPI (3-wires and 4-wires) as digital interface. The`
`27`	`27`	`* driver currently supports:`
Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,7 @@ esp_err_t ht16k33_display_setup(i2c_dev_t *dev, uint8_t on_flag,`
`109`	`109`	`/**`
`110`	`110`	`* @brief Write whole HT16K33_RAM_SIZE_BYTES into RAM.`
`111`	`111`	`*`
	`112`	`+ * @param dev I2C device descriptor`
`112`	`113`	`* @param data Bytes to write.`
`113`	`114`	`* @return ESP_OK to indicate success`
`114`	`115`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,7 @@ esp_err_t si7021_get_device_id(i2c_dev_t dev, si7021_device_id_t id);`
`239`	`239`	`* - SI7021`
`240`	`240`	`*`
`241`	`241`	`* @param dev Device descriptor`
`242`		`- * @param[out] id Device revision`
	`242`	`+ * @param[out] rev Device revision`
`243`	`243`	* @return `ESP_OK` on success
`244`	`244`	`*/`
`245`	`245`	`esp_err_t si7021_get_device_revision(i2c_dev_t dev, uint8_t rev);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-. _sgm58031:`
	`1`	`+.. _sgm58031:`
`2`	`2`
`3`	`3`	`sgm58031 - Driver for SGM58031 16-bit ADC`
`4`	`4`	`=======================================================================`