[FL-1906] Documentation: add Doxyfile, prepare sources for doxygen. (#741)
* Documentation: add Doxyfile, prepare sources for doxygen. * Update ReadMe and remove obsolete CLA * Add contribution guide * Contributing: update text * Correct spelling
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
/**
|
||||
* @file record.h
|
||||
* Furi: record API
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
@@ -6,36 +11,45 @@
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** Initialize record storage
|
||||
* For internal use only.
|
||||
/** Initialize record storage For internal use only.
|
||||
*/
|
||||
void furi_record_init();
|
||||
|
||||
/** Create record
|
||||
* @param name - record name
|
||||
* @param data - data pointer
|
||||
* @note Thread safe. Create and destroy must be executed from the same thread.
|
||||
*
|
||||
* @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
|
||||
* @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.
|
||||
*
|
||||
* @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
|
||||
* @param name - record name
|
||||
* @return pointer to the record
|
||||
* @note Thread safe. Open and close must be executed from the same thread.
|
||||
* Suspends caller thread till record appear
|
||||
*
|
||||
* @param name record name
|
||||
*
|
||||
* @return pointer to the record
|
||||
* @note Thread safe. Open and close must be executed from the same
|
||||
* thread. Suspends caller thread till record appear
|
||||
*/
|
||||
void* furi_record_open(const char* name);
|
||||
|
||||
/** Close record
|
||||
* @param name - record name
|
||||
* @note Thread safe. Open and close must be executed from the same thread.
|
||||
*
|
||||
* @param name record name
|
||||
* @note Thread safe. Open and close must be executed from the same
|
||||
* thread.
|
||||
*/
|
||||
void furi_record_close(const char* name);
|
||||
|
||||
|
Reference in New Issue
Block a user