BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Whitespace and comment improvements, no semantical changes.

This commit is contained in:
Matthias Heidbrink 2014-05-19 19:44:04 +02:00
parent 1ba4a1cf33
commit d0a92abd54
4 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
backend.c
View File

@ -81,7 +81,8 @@ extern struct sr_session *session;
* *
* Initializing and shutting down libsigrok. * 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 * be called to initialize the library, which will return a struct sr_context
* when the initialization was successful. * when the initialization was successful.
* *

17
hardware/common/serial.c
View File

@ -39,7 +39,8 @@
* If the serial structure contains a serialcomm string, it will be * If the serial structure contains a serialcomm string, it will be
* passed to serial_set_paramstr() after the port is opened. * 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) 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. * @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) 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. * @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) 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] 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). * @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. * @retval SR_ERR Failure.
*/ */
SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, 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 * critical, but it helps fine tune the serial port polling
* delay. * 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. * @retval SR_ERR Failure.
*/ */
SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, 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. * Find USB serial devices via the USB vendor ID and product ID.
* *
* @param vendor_id Vendor ID of the USB device. * @param[in] vendor_id Vendor ID of the USB device.
* @param product_id Product 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 * @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 * NULL if no serial device is found. The returned list must be freed

2
libsigrok.h
View File

@ -236,7 +236,7 @@ enum sr_unit {
* a unitless quantity, for example. * a unitless quantity, for example.
*/ */
SR_UNIT_UNITLESS, SR_UNIT_UNITLESS,
/** Sound pressure level relative so 20 micropascals. */ /** Sound pressure level, in decibels, relative to 20 micropascals. */
SR_UNIT_DECIBEL_SPL, SR_UNIT_DECIBEL_SPL,
/** /**
* Normalized (0 to 1) concentration of a substance or compound with 0 * Normalized (0 to 1) concentration of a substance or compound with 0