Start doxygen documentation
This commit is contained in:
@@ -18,6 +18,10 @@
|
||||
* If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file systick.h
|
||||
*/
|
||||
|
||||
#ifndef __SYSTICK_H__
|
||||
#define __SYSTICK_H__
|
||||
|
||||
|
@@ -18,6 +18,15 @@
|
||||
* If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file dma-ring-buffer.h
|
||||
* @brief Header for DMA Ring buffer implemenation
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup dma-ring-buffer DMA Ring Buffers from and to Peripherals
|
||||
*/
|
||||
|
||||
#ifndef __DMA_RING_BUFFER_H__
|
||||
#define __DMA_RING_BUFFER_H__
|
||||
|
||||
@@ -25,6 +34,11 @@
|
||||
#include <stm32/stm32f4xx.h>
|
||||
#include <stddef.h>
|
||||
|
||||
/**
|
||||
* @addtogroup dma-ring-buffer
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @brief DMA ring buffer for data transfer from peripheral to memory
|
||||
*/
|
||||
@@ -124,6 +138,8 @@ void dma_ring_buffer_mem_to_periph_int_callback(struct dma_ring_buffer_to_periph
|
||||
*/
|
||||
void dma_ring_buffer_mem_to_periph_stop(struct dma_ring_buffer_to_periph *buff);
|
||||
|
||||
/** @} */
|
||||
|
||||
#endif /* __DMA_RING_BUFFER_H__ */
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user