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

9
firmware/targets/api-hal-include/api-hal-vcp.h
View File

@@ -8,12 +8,14 @@
extern "C" {
#endif
/* Init VCP HAL
/**
* Init VCP HAL
* Allocates ring buffer and initializes state
*/
void api_hal_vcp_init();
/* Recieve data from VCP
/**
* Recieve data from VCP
* Waits till some data arrives, never returns 0
* @param buffer - pointer to buffer
* @param size - buffer size
@@ -21,7 +23,8 @@ void api_hal_vcp_init();
*/
size_t api_hal_vcp_rx(uint8_t* buffer, size_t size);
/* Transmit data to VCP
/**
* Transmit data to VCP
* @param buffer - pointer to buffer
* @param size - buffer size
*/