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

25
firmware/targets/api-hal-include/api-hal-bt.h
View File

@@ -7,42 +7,43 @@
extern "C" {
#endif
/* Initialize */
/** Initialize */
void api_hal_bt_init();
/* Start BLE app */
/** Start BLE app */
bool api_hal_bt_start_app();
/* Get BT/BLE system component state */
/** Get BT/BLE system component state */
void api_hal_bt_dump_state(string_t buffer);
/* Get BT/BLE system component state */
/** Get BT/BLE system component state */
bool api_hal_bt_is_alive();
/* Lock shared access to flash controller
/**
* Lock shared access to flash controller
* @return true if lock was successful, false if not
*/
bool api_hal_bt_lock_flash();
/* Unlock shared access to flash controller */
/** Unlock shared access to flash controller */
void api_hal_bt_unlock_flash();
/* Start ble tone tx at given channel and power */
/** Start ble tone tx at given channel and power */
void api_hal_bt_start_tone_tx(uint8_t tx_channel, uint8_t power);
/* Stop ble tone tx */
/** Stop ble tone tx */
void api_hal_bt_stop_tone_tx();
/* Start sending ble packets at a given frequency and datarate */
/** Start sending ble packets at a given frequency and datarate */
void api_hal_bt_start_packet_tx(uint8_t frequency, uint8_t datarate);
/* Stop sending ble packets */
/** Stop sending ble packets */
void api_hal_bt_stop_packet_tx();
/* Set up the RF to listen to a given RF channel */
/** Set up the RF to listen to a given RF channel */
void api_hal_bt_start_rx(uint8_t frequency);
/* Stop RF listenning */
/** Stop RF listenning */
void api_hal_bt_stop_rx();
#ifdef __cplusplus