giomba/nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doxygen for tsch-log.h

Browse Source
This commit is contained in:
Simon Duquennoy 2018-04-14 12:18:14 -07:00
parent eb81487267
commit 5734b32a6f
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
os/net/mac/tsch/tsch-log.h
View File

@ -70,7 +70,7 @@
/************ Types ***********/
/* Structure for a log. Union of different types of logs */
/** \brief Structure for a log. Union of different types of logs */
struct tsch_log_t {
enum { tsch_log_tx,
tsch_log_rx,
@ -107,21 +107,31 @@ struct tsch_log_t {
/********** Functions *********/
/* Prepare addition of a new log.
* Returns pointer to log structure if success, NULL otherwise */
/**
* \brief Prepare addition of a new log.
* \return A pointer to log structure if success, NULL otherwise
*/
struct tsch_log_t *tsch_log_prepare_add(void);
/* Actually add the previously prepared log */
/**
* \brief Actually add the previously prepared log
*/
void tsch_log_commit(void);
/* Initialize log module */
/**
* \brief Initialize log module
*/
void tsch_log_init(void);
/* Process pending log messages */
/**
* \brief Process pending log messages
*/
void tsch_log_process_pending(void);
/* Stop logging module */
/**
* \brief Stop logging module
*/
void tsch_log_stop(void);
/************ Macros **********/
/* Use this macro to add a log to the queue (will be printed out
/** \brief Use this macro to add a log to the queue (will be printed out
* later, after leaving interrupt context) */
#define TSCH_LOG_ADD(log_type, init_code) do { \
struct tsch_log_t *log = tsch_log_prepare_add(); \