[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:
@@ -6,26 +6,30 @@
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* Initialize record storage
|
||||
/**
|
||||
* Initialize record storage
|
||||
* For internal use only.
|
||||
*/
|
||||
void furi_record_init();
|
||||
|
||||
/* Create record
|
||||
/**
|
||||
* Create record
|
||||
* @param name - record name
|
||||
* @param data - data pointer
|
||||
* @note Thread safe. Create and destroy must be executed from the same thread.
|
||||
*/
|
||||
void furi_record_create(const char* name, void* data);
|
||||
|
||||
/* Destroy record
|
||||
/**
|
||||
* Destroy record
|
||||
* @param name - record name
|
||||
* @return true if successful, false if still have holders or thread is not owner.
|
||||
* @note Thread safe. Create and destroy must be executed from the same thread.
|
||||
*/
|
||||
bool furi_record_destroy(const char* name);
|
||||
|
||||
/* Open record
|
||||
/**
|
||||
* Open record
|
||||
* @param name - record name
|
||||
* @return pointer to the record
|
||||
* @note Thread safe. Open and close must be executed from the same thread.
|
||||
@@ -33,7 +37,8 @@ bool furi_record_destroy(const char* name);
|
||||
*/
|
||||
void* furi_record_open(const char* name);
|
||||
|
||||
/* Close record
|
||||
/**
|
||||
* Close record
|
||||
* @param name - record name
|
||||
* @note Thread safe. Open and close must be executed from the same thread.
|
||||
*/
|
||||
|
Reference in New Issue
Block a user