docs: fix all doxygen warnings

Doxygen warnings would previously not result in a failed pipeline.
Fixed this as well as all current warnings.
This commit is contained in:
Marius Vikhammer
2022-05-11 15:52:09 +08:00
parent af1f342ee8
commit c8617fe965
42 changed files with 184 additions and 162 deletions

View File

@@ -14,7 +14,8 @@ extern "C" {
#endif
/**
* @file PHY init parameters and API
* @file
* init parameters and API
*/
@@ -34,6 +35,10 @@ typedef struct {
uint8_t opaque[1894]; /*!< calibration data */
} esp_phy_calibration_data_t;
/**
* @brief PHY calibration mode
*
*/
typedef enum {
PHY_RF_CAL_PARTIAL = 0x00000000, /*!< Do part of RF calibration. This should be used after power-on reset. */
PHY_RF_CAL_NONE = 0x00000001, /*!< Don't do any RF calibration. This mode is only suggested to be used after deep sleep reset. */
@@ -208,6 +213,10 @@ int64_t esp_phy_rf_get_on_ts(void);
/**
* @brief Update the corresponding PHY init type according to the country code of Wi-Fi.
*
* @param country country code
* @return ESP_OK on success.
* @return esp_err_t code describing the error on fail
*/
esp_err_t esp_phy_update_country_info(const char *country);