add: doxygen
This commit is contained in:
parent
18804da4d8
commit
7b6ee283c6
7 changed files with 2737 additions and 145 deletions
include/models
|
@ -8,9 +8,20 @@
|
|||
#include <config.h>
|
||||
#include <models/relay.h>
|
||||
|
||||
/**
|
||||
* @brief Information about this controller
|
||||
*/
|
||||
typedef struct controller
|
||||
{
|
||||
/**
|
||||
* @brief A unique UUID for this controller
|
||||
*/
|
||||
uuid_t uuid;
|
||||
/**
|
||||
* @brief The name of this controller
|
||||
*
|
||||
* Includes a \0 terminator.
|
||||
*/
|
||||
char name[CONTROLLER_NAME_LENGTH + 1];
|
||||
uint16_t port;
|
||||
uint8_t relay_count;
|
||||
|
@ -31,8 +42,16 @@ controller*
|
|||
controller_create(void);
|
||||
|
||||
controller*
|
||||
controller_read(MDB_env *mdb_env);
|
||||
controller_load(MDB_env *mdb_env);
|
||||
|
||||
/**
|
||||
* @brief Save a controller to the database
|
||||
*
|
||||
* @param cntrlr Instance of a controller
|
||||
* @param mdb_env Already created MDB_env
|
||||
*
|
||||
* @return Indicator to show success (0) or failure (!0)
|
||||
*/
|
||||
int
|
||||
controller_save(controller *cntrlr, MDB_env *mdb_env);
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue