Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bugfix: fix doxygen comments and docs, update doxygen config #553

Merged
merged 1 commit into from
Aug 5, 2023
Merged

bugfix: fix doxygen comments and docs, update doxygen config #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/ads130e08/ads130e08.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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__ */
2 changes: 1 addition & 1 deletion components/dps310/include/dps310.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions components/ht16k33/ht16k33.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
12 changes: 0 additions & 12 deletions components/sgm58031/sgm58031.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
2 changes: 1 addition & 1 deletion components/si7021/si7021.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
472 changes: 298 additions & 174 deletions docs/doxygen.conf
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source/groups/sgm58031.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
. _sgm58031:
.. _sgm58031:

sgm58031 - Driver for SGM58031 16-bit ADC
=======================================================================
Expand Down