Doxygen: Fix various warnings.

[libsigrok.git] / src / serial.c

diff --git a/src/serial.c b/src/serial.c
index a2d0189fbb734c9908079e3d8bee768acc48b82a..1c0870d9f61cf9c1fe168cc76d21339a6b1a69a2 100644 (file)
--- a/src/serial.c
+++ b/src/serial.c
@@ -55,12 +55,10 @@
 
 #ifdef HAVE_SERIAL_COMM
 
-/* See if a (assumed opened) serial port is of any supported type. */
+/* See if an (assumed opened) serial port is of any supported type. */
 static int dev_is_supported(struct sr_serial_dev_inst *serial)
 {
-       if (!serial)
-               return 0;
-       if (!serial->lib_funcs)
+       if (!serial || !serial->lib_funcs)
                return 0;
 
        return 1;
@@ -246,7 +244,9 @@ SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial)
  * @retval SR_ERR_ARG Invalid parameters.
  * @retval SR_OK Successful registration.
  *
- * Callbacks get unregistered by specifying #NULL for the 'cb' parameter.
+ * Callbacks get unregistered by specifying NULL for the 'cb' parameter.
+ *
+ * @private
  */
 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
        serial_rx_chunk_callback cb, void *cb_data)
@@ -266,13 +266,11 @@ SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
  *
  * @param[in] serial Previously opened serial port instance.
  *
- * @internal
+ * @private
  */
 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
 {
-       if (!serial)
-               return;
-       if (!serial->rcv_buffer)
+       if (!serial || !serial->rcv_buffer)
                return;
 
        g_string_truncate(serial->rcv_buffer, 0);
@@ -284,13 +282,11 @@ SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial)
  *
  * @param[in] serial Previously opened serial port instance.
  *
- * @internal
+ * @private
  */
 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
 {
-       if (!serial)
-               return 0;
-       if (!serial->rcv_buffer)
+       if (!serial || !serial->rcv_buffer)
                return 0;
 
        return serial->rcv_buffer->len;
@@ -304,14 +300,12 @@ SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial)
  * @param[in] data Pointer to data bytes to queue.
  * @param[in] len Number of data bytes to queue.
  *
- * @internal
+ * @private
  */
 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
        const uint8_t *data, size_t len)
 {
-       if (!serial)
-               return;
-       if (!data || !len)
+       if (!serial || !data || !len)
                return;
 
        if (serial->rx_chunk_cb_func)
@@ -328,7 +322,7 @@ SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
  * @param[out] data Pointer to store retrieved data bytes into.
  * @param[in] len Number of data bytes to retrieve.
  *
- * @internal
+ * @private
  */
 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
        uint8_t *data, size_t len)
@@ -336,9 +330,7 @@ SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
        size_t qlen;
        GString *buf;
 
-       if (!serial)
-               return 0;
-       if (!data || !len)
+       if (!serial || !data || !len)
                return 0;
 
        qlen = sr_ser_has_queued_data(serial);
@@ -365,6 +357,8 @@ SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
  *
  * Returns 0 if no receive data is available, or if the amount of
  * available receive data cannot get determined.
+ *
+ * @private
  */
 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial)
 {
@@ -1027,9 +1021,7 @@ SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id)
 /** @private */
 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes)
 {
-       int bits, baud;
-       int ret;
-       int timeout_ms;
+       int bits, baud, ret, timeout_ms;
 
        /* Get the bitrate and frame length. */
        bits = baud = 0;