X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=log.c;h=46fa9e5fc5519da2e276d1294930ca2e96bb5c04;hp=7b30497ee1226882b5e89ebe23bbefcf9198c596;hb=1f2e00d140ac41a3a61888f67fc6f96c4369bea3;hpb=50bd5d259677faf87bb3408e111d0e833d7ba9b4

diff --git a/log.c b/log.c
index 7b30497..46fa9e5 100644
--- a/log.c
+++ b/log.c
@@ -18,8 +18,8 @@
  * 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>
 
@@ -75,6 +75,8 @@ static char srd_log_domain[LOGDOMAIN_MAXLEN + 1] = LOGDOMAIN_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)
 {
@@ -94,6 +96,8 @@ 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)
 {
@@ -113,6 +117,8 @@ 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)
 {
@@ -121,7 +127,6 @@ 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);
@@ -135,6 +140,8 @@ SRD_API int srd_log_logdomain_set(const char *logdomain)
  * @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)
 {
@@ -154,6 +161,8 @@ 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)
 {
@@ -176,6 +185,8 @@ 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)
 {
@@ -199,7 +210,7 @@ static int srd_logv(void *cb_data, int loglevel, const char *format,
 
 	/* 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);