Added doxgen comments to filesyste, checkbox, numupdown and screen module. And some minor changes to the other modules.
This commit is contained in:
@@ -1,5 +1,22 @@
|
||||
#include "filesystem.h"
|
||||
|
||||
/**
|
||||
* @addtogroup lowlevel
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup ll_filesystem Filesystem (LowLevel)
|
||||
* Low level functions for the \ref filesystem module
|
||||
*/
|
||||
/*@}*/
|
||||
|
||||
/**
|
||||
* @addtogroup ll_filesystem
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
|
||||
bool ll_filesystem_init();
|
||||
|
||||
DIRECTORY_STRUCT* ll_filesystem_dir_open(const char* path);
|
||||
@@ -9,3 +26,5 @@ void ll_filesystem_file_close(FILE_HANDLE* handle);
|
||||
FILE_STATUS ll_filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset);
|
||||
FILE_STATUS ll_filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size);
|
||||
FILE_STATUS ll_filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size);
|
||||
|
||||
/*@}*/
|
||||
|
||||
@@ -1,7 +1,29 @@
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
|
||||
|
||||
/**
|
||||
* @defgroup lowlevel LowLevel
|
||||
* The Low-Level platform abstraction layer
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup ll_system System (LowLevel)
|
||||
* Low level functions of the \ref system Module
|
||||
*/
|
||||
|
||||
/*@}*/
|
||||
|
||||
/**
|
||||
* @addtogroup ll_system
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
|
||||
bool ll_system_init();
|
||||
void ll_system_delay(uint32_t msec);
|
||||
void ll_system_process();
|
||||
void ll_system_toggle_led();
|
||||
|
||||
/*@}*/
|
||||
|
||||
@@ -1,6 +1,23 @@
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
|
||||
/**
|
||||
* @addtogroup lowlevel
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup ll_tft TFT (LowLevel)
|
||||
* Low level functions for the \ref tft module
|
||||
*/
|
||||
/*@}*/
|
||||
|
||||
/**
|
||||
* @addtogroup ll_tft
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
// init functions
|
||||
bool ll_tft_init();
|
||||
|
||||
@@ -19,6 +36,6 @@ uint8_t ll_tft_font_height(uint8_t fontnum);
|
||||
uint8_t ll_tft_font_width(uint8_t fontnum);
|
||||
void ll_tft_draw_char(uint16_t x, uint16_t y, uint16_t color, uint16_t bgcolor, uint8_t font, char c);
|
||||
|
||||
|
||||
/*@}*/
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,23 @@
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
/**
|
||||
* @addtogroup lowlevel
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup ll_touch Touch (LowLevel)
|
||||
* Low level functions for the \ref touch module
|
||||
*/
|
||||
/*@}*/
|
||||
|
||||
/**
|
||||
* @addtogroup ll_touch
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
|
||||
bool ll_touch_init();
|
||||
|
||||
|
||||
/*@}*/
|
||||
|
||||
Reference in New Issue
Block a user