/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrokdecode project.
*
* Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
*
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#include "sigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
-#include "sigrokdecode-internal.h"
+#include "libsigrokdecode.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#include "libsigrokdecode-internal.h"
#include <stdarg.h>
#include <stdio.h>
* Controlling the libsigrokdecode message logging functionality.
*/
+/**
+ * @defgroup grp_logging Logging
+ *
+ * Controlling the libsigrokdecode message logging functionality.
+ *
+ * @{
+ */
+
/* Currently selected libsigrokdecode loglevel. Default: SRD_LOG_WARN. */
static int srd_loglevel = SRD_LOG_WARN; /* Show errors+warnings per default. */
* SRD_LOG_WARN, SRD_LOG_INFO, SRD_LOG_DBG, or SRD_LOG_SPEW).
*
* @return SRD_OK upon success, SRD_ERR_ARG upon invalid loglevel.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_log_loglevel_set(int loglevel)
{
* Get the libsigrokdecode loglevel.
*
* @return The currently configured libsigrokdecode loglevel.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_log_loglevel_get(void)
{
* the caller does not need to keep it around.
*
* @return SRD_OK upon success, SRD_ERR_ARG upon invalid logdomain.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_log_logdomain_set(const char *logdomain)
{
return SRD_ERR_ARG;
}
- /* TODO: Error handling. */
snprintf((char *)&srd_log_domain, LOGDOMAIN_MAXLEN, "%s", logdomain);
srd_dbg("Log domain set to '%s'.", (const char *)&srd_log_domain);
* @return A copy of the currently configured libsigrokdecode logdomain
* string. The caller is responsible for g_free()ing the string when
* it is no longer needed.
+ *
+ * @since 0.1.0
*/
SRD_API char *srd_log_logdomain_get(void)
{
* pass any data.
*
* @return SRD_OK upon success, SRD_ERR_ARG upon invalid arguments.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_log_callback_set(srd_log_callback_t cb, void *cb_data)
{
* Additionally, the internal 'srd_log_callback_data' pointer is set to NULL.
*
* @return SRD_OK upon success, a (negative) error code otherwise.
+ *
+ * @since 0.1.0
*/
SRD_API int srd_log_callback_set_default(void)
{
/* Only output messages of at least the selected loglevel(s). */
if (loglevel > srd_loglevel)
- return SRD_OK; /* TODO? */
+ return SRD_OK;
if (srd_log_domain[0] != '\0')
fprintf(stderr, "%s", srd_log_domain);
return ret;
}
+
+/** @} */