summaryrefslogtreecommitdiffstats
path: root/common/eurephia_log.c
diff options
context:
space:
mode:
authorDavid Sommerseth <dazo@users.sourceforge.net>2009-09-24 01:05:41 +0200
committerDavid Sommerseth <dazo@users.sourceforge.net>2009-09-24 01:05:41 +0200
commit343b51689a958ee35068699ba89f478893b7a12a (patch)
tree387a9c79c4e45756d19675e92af2f370e39264be /common/eurephia_log.c
parentf2a4f0412bc1f7b9069ecbcce8f5599f46f757e0 (diff)
downloadeurephia-343b51689a958ee35068699ba89f478893b7a12a.tar.gz
eurephia-343b51689a958ee35068699ba89f478893b7a12a.tar.xz
eurephia-343b51689a958ee35068699ba89f478893b7a12a.zip
Added missing doxygen comments after the last eurephia_log() improvements
Ref. commit: f2a4f0412bc1f7b9069ecbcce8f5599f46f757e0
Diffstat (limited to 'common/eurephia_log.c')
-rw-r--r--common/eurephia_log.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/common/eurephia_log.c b/common/eurephia_log.c
index defe781..94c901a 100644
--- a/common/eurephia_log.c
+++ b/common/eurephia_log.c
@@ -161,6 +161,8 @@ pthread_mutex_t log_mutex = PTHREAD_MUTEX_INITIALIZER;
* @param log FILE pointer to a log file
* @param logdst Log destiation/priority
* @param loglvl Log level of the message
+ * @param file String containing file name of the place this function was called. Usually the __FILE__ macro.
+ * @param line Line number of the source file this function was called. Usually the __LINE__ macro.
* @param fmt stdarg, format string
* @param ap stdarg va_list, prepared by va_start()
*/
@@ -197,13 +199,15 @@ static void file_log(FILE *log, int logdst, int loglvl, const char *file, const
}
/**
- * Simple log function which writes log data to the log file available in the eurephiaCTX
+ * Internal function. This function should normally be called via the eurephia_log() function.
*
* @param ctx eurephiaCTX
* @param logdst Log destination, can be LOG_INFO, LOG_DEBUG, LOG_WARNING, LOG_ERROR,
* LOG_CRITICAL, LOG_FATAL or LOG_PANIC
* @param loglvl Log level of the message. If the eurephiaCTX has a lower log level setup
* than what this parameter is set to, the message will not be logged.
+ * @param file String containing file name of the place this function was called. Usually the __FILE__ macro.
+ * @param line Line number of the source file this function was called. Usually the __LINE__ macro.
* @param fmt Contents of the log message (stdarg)
*/
void _eurephia_log_func(eurephiaCTX *ctx, int logdst, int loglvl, const char *file, const int line,