Added missing doxygen comments after the last eurephia_log() improvements

Ref. commit: f2a4f0412bc1f7b9069ecbcce8f5599f46f757e0

1 files changed, 9 insertions, 0 deletions

diff --git a/common/eurephia_log.h b/common/eurephia_log.h
index 07aaea3..77511d0 100644
--- a/common/eurephia_log.h
+++ b/common/eurephia_log.h
@@ -57,6 +57,15 @@
 int eurephia_log_init(eurephiaCTX *ctx, const char *dest, int loglvl);
 void eurephia_log_close(eurephiaCTX *ctx);
 
+/**
+ * Simple log function which writes log data to the log file available in the eurephiaCTX
+ * Frontend wrapper for the _eurephia_log_func() function.
+ *
+ * @param ctx eurephiaCTX
+ * @param dst Log destination/priority (LOG_INFO, LOG_PANIC, LOG_ERROR, etc)
+ * @param lvl Verbosity level of the message
+ * @param log_string The message to be logged
+ */
 #define eurephia_log(ctx, dst, lvl, log_string...) _eurephia_log_func(ctx, dst, lvl, __FILE__, __LINE__, ## log_string)
 void _eurephia_log_func(eurephiaCTX *ctx, int logdst, int loglvl, const char *file, int line,
                         const char *fmt, ... );