From: Matthias Heidbrink <redacted>
Date: Mon, 19 May 2014 17:44:04 +0000 (+0200)
Subject: Whitespace and comment improvements, no semantical changes.
X-Git-Tag: libsigrok-0.4.0~1316
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=d0a92abd543345beb5bcc4d2ddf87936a35d1fb3;p=libsigrok.git

Whitespace and comment improvements, no semantical changes.
---

diff --git a/backend.c b/backend.c
index 2f51eedd..ab668efa 100644
--- a/backend.c
+++ b/backend.c
@@ -81,7 +81,8 @@ extern struct sr_session *session;
  *
  * Initializing and shutting down libsigrok.
  *
- * Before using any of the libsigrok functionality, sr_init() must
+ * Before using any of the libsigrok functionality (except
+ * sr_log_loglevel_set() and sr_log_opts_set()), sr_init() must
  * be called to initialize the library, which will return a struct sr_context
  * when the initialization was successful.
  *
diff --git a/configure.ac b/configure.ac
index 6b454883..496bc7a2 100644
--- a/configure.ac
+++ b/configure.ac
@@ -388,8 +388,8 @@ AM_CONDITIONAL(HAVE_CHECK, test x"$have_check" = "xyes")
 # will not currently work on Windows.
 case "$host" in
 *mingw*)
-       HW_OLS="no"
-       ;;
+	HW_OLS="no"
+	;;
 esac
 
 AC_SUBST(SR_PKGLIBS)
@@ -415,7 +415,7 @@ fi
 
 AM_CONDITIONAL(HW_ATTEN_PPS3XXX, test x$HW_ATTEN_PPS3XXX = xyes)
 if test "x$HW_ATTEN_PPS3XXX" = "xyes"; then
-       AC_DEFINE(HAVE_HW_ATTEN_PPS3XXX, 1, [Atten PPS3xxx support])
+	AC_DEFINE(HAVE_HW_ATTEN_PPS3XXX, 1, [Atten PPS3xxx support])
 fi
 
 AM_CONDITIONAL(HW_BRYMEN_BM86X, test x$HW_BRYMEN_BM86X = xyes)
@@ -515,7 +515,7 @@ fi
 
 AM_CONDITIONAL(HW_NORMA_DMM, test x$HW_NORMA_DMM = xyes)
 if test "x$HW_NORMA_DMM" = "xyes"; then
-       AC_DEFINE(HAVE_HW_NORMA_DMM, 1, [Norma DMM support])
+	AC_DEFINE(HAVE_HW_NORMA_DMM, 1, [Norma DMM support])
 fi
 
 AM_CONDITIONAL(HW_OLS, test x$HW_OLS = xyes)
diff --git a/hardware/common/serial.c b/hardware/common/serial.c
index e99b768b..10f8c76c 100644
--- a/hardware/common/serial.c
+++ b/hardware/common/serial.c
@@ -39,7 +39,8 @@
  * If the serial structure contains a serialcomm string, it will be
  * passed to serial_set_paramstr() after the port is opened.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
 {
@@ -88,7 +89,8 @@ SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags)
  *
  * @param serial Previously initialized serial port structure.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
 {
@@ -132,7 +134,8 @@ SR_PRIV int serial_close(struct sr_serial_dev_inst *serial)
  *
  * @param serial Previously initialized serial port structure.
  *
- * @return SR_OK on success, SR_ERR on failure.
+ * @retval SR_OK Success.
+ * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial)
 {
@@ -310,7 +313,7 @@ SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf
  * @param[in] rts Status of RTS line (0 or 1; required by some interfaces).
  * @param[in] dtr Status of DTR line (0 or 1; required by some interfaces).
  *
- * @retval SR_OK Success
+ * @retval SR_OK Success.
  * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
@@ -565,7 +568,7 @@ SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
  *                 critical, but it helps fine tune the serial port polling
  *                 delay.
  *
- * @retval SR_OK Valid packet was found within the given timeout
+ * @retval SR_OK Valid packet was found within the given timeout.
  * @retval SR_ERR Failure.
  */
 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
@@ -748,8 +751,8 @@ SR_PRIV int serial_source_remove(struct sr_serial_dev_inst *serial)
 /**
  * Find USB serial devices via the USB vendor ID and product ID.
  *
- * @param vendor_id Vendor ID of the USB device.
- * @param product_id Product ID of the USB device.
+ * @param[in] vendor_id Vendor ID of the USB device.
+ * @param[in] product_id Product ID of the USB device.
  *
  * @return A GSList of strings containing the path of the serial device or
  *         NULL if no serial device is found. The returned list must be freed
diff --git a/libsigrok.h b/libsigrok.h
index 0b6888d9..abcc2895 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -236,7 +236,7 @@ enum sr_unit {
 	 * a unitless quantity, for example.
 	 */
 	SR_UNIT_UNITLESS,
-	/** Sound pressure level relative so 20 micropascals. */
+	/** Sound pressure level, in decibels, relative to 20 micropascals. */
 	SR_UNIT_DECIBEL_SPL,
 	/**
 	 * Normalized (0 to 1) concentration of a substance or compound with 0