[FL-41] api-hal doxygen documentation (#387)

* targets/api-hal: rework documentation in doxygen style
* core/api-hal: rework documentation in doxygen style
* core/furi: rework documentation in doxygen style
* drivers: rework documentation in doxygen style

Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
gornekich
2021-03-24 12:35:33 +03:00
committed by GitHub
parent cc263d743b
commit 610f4f5d73
23 changed files with 325 additions and 161 deletions

View File

@@ -3,32 +3,32 @@
#include <stdbool.h>
#include <stdint.h>
/* Initialize Driver */
/** Initialize Driver */
void bq25896_init();
/* Send device into shipping mode */
/** Send device into shipping mode */
void bq25896_poweroff();
/* Is currently charging */
/** Is currently charging */
bool bq25896_is_charging();
/* Enable otg */
/** Enable otg */
void bq25896_enable_otg();
/* Disable otg */
/** Disable otg */
void bq25896_disable_otg();
/* Get VBUS Voltage in mV */
/** Get VBUS Voltage in mV */
uint16_t bq25896_get_vbus_voltage();
/* Get VSYS Voltage in mV */
/** Get VSYS Voltage in mV */
uint16_t bq25896_get_vsys_voltage();
/* Get VBAT Voltage in mV */
/** Get VBAT Voltage in mV */
uint16_t bq25896_get_vbat_voltage();
/* Get VBAT current in mA */
/** Get VBAT current in mA */
uint16_t bq25896_get_vbat_current();
/* Get NTC voltage in mpct of REGN */
/** Get NTC voltage in mpct of REGN */
uint32_t bq25896_get_ntc_mpct();