liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

20
lib/drivers/bq27220.h
View File

@@ -43,32 +43,32 @@ typedef struct {
uint8_t RSVD0 : 5;
} OperationStatus;
/* Initialize Driver */
/** Initialize Driver */
void bq27220_init();
/* Get battery voltage in mV or error */
/** Get battery voltage in mV or error */
uint16_t bq27220_get_voltage();
/* Get current in mA or error*/
/** Get current in mA or error*/
int16_t bq27220_get_current();
/* Get battery status */
/** Get battery status */
uint8_t bq27220_get_battery_status(BatteryStatus* battery_status);
/* Get operation status */
/** Get operation status */
uint8_t bq27220_get_operation_status(OperationStatus* operation_status);
/* Get temperature in units of 0.1°K */
/** Get temperature in units of 0.1°K */
uint16_t bq27220_get_temperature();
/* Get compensated full charge capacity in in mAh */
/** Get compensated full charge capacity in in mAh */
uint16_t bq27220_get_full_charge_capacity();
/* Get remaining capacity in in mAh */
/** Get remaining capacity in in mAh */
uint16_t bq27220_get_remaining_capacity();
/* Get predicted remaining battery capacity in percents */
/** Get predicted remaining battery capacity in percents */
uint16_t bq27220_get_state_of_charge();
/* Get ratio of full charge capacity over design capacity in percents */
/** Get ratio of full charge capacity over design capacity in percents */
uint16_t bq27220_get_state_of_health();