gmc-mh-1x-2x: Support for interface SI232-II with driver gmc-mh-2x-bd232.

[libsigrok.git] / backend.c

diff --git a/backend.c b/backend.c
index 42817158f4f11e877a53343280e66bbdbd56b342..0ed16a58f47fc894cf126dc73180055f3e41f520 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -23,6 +23,8 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+#define LOG_PREFIX "backend"
+
 extern struct sr_session *session;
 
 /**
@@ -96,7 +98,7 @@ extern struct sr_session *session;
  *     struct sr_context *sr_ctx;
  *
  *     if ((ret = sr_init(&sr_ctx)) != SR_OK) {
- *             printf("Error initializing libsigrok (%s): %s.",
+ *             printf("Error initializing libsigrok (%s): %s.\n",
  *                    sr_strerror_name(ret), sr_strerror(ret));
  *             return 1;
  *     }
@@ -104,7 +106,7 @@ extern struct sr_session *session;
  *     // Use libsigrok functions here...
  *
  *     if ((ret = sr_exit(sr_ctx)) != SR_OK) {
- *             printf("Error shutting down libsigrok (%s): %s.",
+ *             printf("Error shutting down libsigrok (%s): %s.\n",
  *                    sr_strerror_name(ret), sr_strerror(ret));
  *             return 1;
  *     }
@@ -119,7 +121,8 @@ extern struct sr_session *session;
 /**
  * Sanity-check all libsigrok drivers.
  *
- * @return SR_OK if all drivers are OK, SR_ERR if one or more have issues.
+ * @retval SR_OK All drivers are OK
+ * @retval SR_ERR One or more drivers have issues.
  */
 static int sanity_check_all_drivers(void)
 {
@@ -209,7 +212,8 @@ static int sanity_check_all_drivers(void)
 /**
  * Sanity-check all libsigrok input modules.
  *
- * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules have issues.
  */
 static int sanity_check_all_input_modules(void)
 {
@@ -258,7 +262,8 @@ static int sanity_check_all_input_modules(void)
 /**
  * Sanity-check all libsigrok output modules.
  *
- * @return SR_OK if all modules are OK, SR_ERR if one or more have issues.
+ * @retval SR_OK All modules are OK
+ * @retval SR_ERR One or more modules have issues.
  */
 static int sanity_check_all_output_modules(void)
 {
@@ -322,7 +327,7 @@ static int sanity_check_all_output_modules(void)
  *         the context will be free'd by sr_exit() as part of the libsigrok
  *         shutdown.
  *
- * @since 0.1.0 (but the API changed in 0.2.0)
+ * @since 0.2.0
  */
 SR_API int sr_init(struct sr_context **ctx)
 {
@@ -360,7 +365,7 @@ SR_API int sr_init(struct sr_context **ctx)
 #ifdef HAVE_LIBUSB_1_0
        ret = libusb_init(&context->libusb_ctx);
        if (LIBUSB_SUCCESS != ret) {
-               sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
+               sr_err("libusb_init() returned %s.", libusb_error_name(ret));
                ret = SR_ERR;
                goto done;
        }
@@ -382,9 +387,10 @@ done:
  *
  * @param ctx Pointer to a libsigrok context struct. Must not be NULL.
  *
- * @return SR_OK upon success, a (negative) error code otherwise.
+ * @retval SR_OK Success
+ * @retval other Error code SR_ERR, ...
  *
- * @since 0.1.0 (but the API changed in 0.2.0)
+ * @since 0.2.0
  */
 SR_API int sr_exit(struct sr_context *ctx)
 {