[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 api-interrupt-mgr.h
|
||||
* Furi: interrupt API
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
@@ -23,45 +28,45 @@ typedef struct {
|
||||
bool ready;
|
||||
} InterruptCallbackItem;
|
||||
|
||||
/**
|
||||
* Init interrupt
|
||||
* @return true on succsessful initialization, false otherwise
|
||||
/** Init interrupt
|
||||
*
|
||||
* @return true on succsessful initialization, false otherwise
|
||||
*/
|
||||
bool api_interrupt_init();
|
||||
|
||||
/**
|
||||
* Add interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
* @param context context for callback
|
||||
/** Add interrupt
|
||||
*
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
* @param context context for callback
|
||||
*/
|
||||
void api_interrupt_add(InterruptCallback callback, InterruptType type, void* context);
|
||||
|
||||
/**
|
||||
* Remove interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
/** Remove interrupt
|
||||
*
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
*/
|
||||
void api_interrupt_remove(InterruptCallback callback, InterruptType type);
|
||||
|
||||
/**
|
||||
* Enable interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
/** Enable interrupt
|
||||
*
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
*/
|
||||
void api_interrupt_enable(InterruptCallback callback, InterruptType type);
|
||||
|
||||
/**
|
||||
* Disable interrupt
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
/** Disable interrupt
|
||||
*
|
||||
* @param callback InterruptCallback
|
||||
* @param type InterruptType
|
||||
*/
|
||||
void api_interrupt_disable(InterruptCallback callback, InterruptType type);
|
||||
|
||||
/**
|
||||
* Call interrupt
|
||||
* @param type InterruptType
|
||||
* @param hw pointer to hardware peripheral
|
||||
/** Call interrupt
|
||||
*
|
||||
* @param type InterruptType
|
||||
* @param hw pointer to hardware peripheral
|
||||
*/
|
||||
void api_interrupt_call(InterruptType type, void* hw);
|
||||
|
||||
|
Reference in New Issue
Block a user