X-Git-Url: http://sigrok.org/gitweb/?p=libserialport.git;a=blobdiff_plain;f=libserialport.h.in;h=8962ef8d942eb5fb6f368408b62feea9998a2a97;hp=0b46497c477dfd6ef3573d6aeb6c9db9266e3e18;hb=962143bc5c3a9a6e130cc1273ab465238c178d70;hpb=e4f44cf5f22c40ec7daedc895458426de8340dff

diff --git a/libserialport.h.in b/libserialport.h.in
index 0b46497..8962ef8 100644
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -1,7 +1,9 @@
 /*
  * This file is part of the libserialport project.
  *
- * Copyright (C) 2013 Martin Ling <martin-libserialport@earth.li>
+ * Copyright (C) 2013, 2015 Martin Ling <martin-libserialport@earth.li>
+ * Copyright (C) 2014 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2014 Aurelien Jacobs <aurel@gnuage.org>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as
@@ -29,27 +31,80 @@
  * By writing your serial code to use libserialport, you enable it to work
  * transparently on any platform supported by the library.
  *
- * The operations that are supported are:
+ * libserialport is an open source project released under the LGPL3+ license.
+ *
+ * The library is maintained by the [sigrok](http://sigrok.org/) project. See
+ * the [libserialport homepage](http://sigrok.org/wiki/Libserialport) for the
+ * latest information.
+ *
+ * Source code is maintained in git at
+ * [git://sigrok.org/libserialport](http://sigrok.org/gitweb/?p=libserialport.git).
+ *
+ * Bugs are tracked at http://sigrok.org/bugzilla/.
+ *
+ * The library was conceived and designed by Martin Ling, is maintained by
+ * Uwe Hermann, and has received contributions from several other developers.
+ * See the git history for full credits.
+ *
+ * API information
+ * ===============
+ *
+ * The API has been designed from scratch. It does not exactly resemble the
+ * serial API of any particular operating system. Instead it aims to provide
+ * a set of functions that can reliably be implemented across all operating
+ * systems. These form a sufficient basis for higher level behaviour to
+ * be implemented in a platform independent manner.
+ *
+ * If you are porting code written for a particular OS, you may find you need
+ * to restructure things somewhat, or do without some specialised features.
+ * For particular notes on porting existing code, see @ref Porting.
+ *
+ * The following subsections will help explain the principles of the API.
+ *
+ * Headers
+ * -------
+ *
+ * To use libserialport functions in your code, you should include the
+ * libserialport.h header, i.e. "#include <libserialport.h>".
+ *
+ * Namespace
+ * ---------
+ *
+ * All identifiers defined by the public libserialport headers use the prefix
+ * sp_ (for functions and data types) or SP_ (for macros and constants).
+ *
+ * Functions
+ * ---------
+ *
+ * The functions provided by the library are documented in detail in
+ * the following sections:
  *
  * - @ref Enumeration (obtaining a list of serial ports on the system)
- * - @ref Ports
+ * - @ref Ports (opening, closing and getting information about ports)
  * - @ref Configuration (baud rate, parity, etc.)
  * - @ref Signals (modem control lines, breaks, etc.)
- * - @ref Data
- * - @ref Waiting
- * - @ref Errors
+ * - @ref Data (reading and writing data, and buffer management)
+ * - @ref Waiting (waiting for ports to be ready, integrating with event loops)
+ * - @ref Errors (getting error and debugging information)
  *
- * libserialport is an open source project released under the LGPL3+ license.
+ * Data structures
+ * ---------------
  *
- * API principles
- * ==============
+ * The library defines three data structures:
  *
- * The API is simple, and designed to be a minimal wrapper around the serial
- * port support in each OS.
+ * - @ref sp_port, which represents a serial port.
+ *   See @ref Enumeration.
+ * - @ref sp_port_config, which represents a port configuration.
+ *   See @ref Configuration.
+ * - @ref sp_event_set, which represents a set of events.
+ *   See @ref Waiting.
  *
- * Most functions take a pointer to a struct sp_port, which represents a serial
- * port. These structures are always allocated and freed by the library, using
- * the functions in the @ref Enumeration "Enumeration" section.
+ * All these structures are allocated and freed by library functions. It is
+ * the caller's responsibility to ensure that the correct calls are made to
+ * free allocated structures after use.
+ *
+ * Return codes and error handling
+ * -------------------------------
  *
  * Most functions have return type @ref sp_return and can return only four
  * possible error values:
@@ -75,6 +130,124 @@
  * Calls that succeed return @ref SP_OK, which is equal to zero. Some functions
  * declared @ref sp_return can also return a positive value for a successful
  * numeric result, e.g. sp_blocking_read() or sp_blocking_write().
+ *
+ * An error message is only available via sp_last_error_message() in the case
+ * where SP_ERR_FAIL was returned by the previous function call. The error
+ * message returned is that provided by the OS, using the current language
+ * settings. It is an error to call sp_last_error_code() or
+ * sp_last_error_message() except after a previous function call returned
+ * SP_ERR_FAIL. The library does not define its own error codes or messages
+ * to accompany other return codes.
+ *
+ * Thread safety
+ * -------------
+ *
+ * Certain combinations of calls can be made concurrently, as follows.
+ *
+ * - Calls using different ports may always be made concurrently, i.e.
+ *   it is safe for separate threads to handle their own ports.
+ *
+ * - Calls using the same port may be made concurrently when one call
+ *   is a read operation and one call is a write operation, i.e. it is safe
+ *   to use separate "reader" and "writer" threads for the same port. See
+ *   below for which operations meet these definitions.
+ *
+ * Read operations:
+ *
+ * - sp_blocking_read()
+ * - sp_blocking_read_next()
+ * - sp_nonblocking_read()
+ * - sp_input_waiting()
+ * - sp_flush() with @ref SP_BUF_INPUT only.
+ * - sp_wait() with @ref SP_EVENT_RX_READY only.
+ *
+ * Write operations:
+ *
+ * - sp_blocking_write()
+ * - sp_nonblocking_write()
+ * - sp_output_waiting()
+ * - sp_drain()
+ * - sp_flush() with @ref SP_BUF_OUTPUT only.
+ * - sp_wait() with @ref SP_EVENT_TX_READY only.
+ *
+ * If two calls, on the same port, do not fit into one of these categories
+ * each, then they may not be made concurrently.
+ *
+ * Debugging
+ * ---------
+ *
+ * The library can output extensive tracing and debugging information. The
+ * simplest way to use this is to set the environment variable
+ * LIBSERIALPORT_DEBUG to any value; messages will then be output to the
+ * standard error stream.
+ *
+ * This behaviour is implemented by a default debug message handling
+ * callback. An alternative callback can be set using sp_set_debug_handler(),
+ * in order to e.g. redirect the output elsewhere or filter it.
+ *
+ * No guarantees are made about the content of the debug output; it is chosen
+ * to suit the needs of the developers and may change between releases.
+ *
+ * @anchor Porting
+ * Porting
+ * -------
+ *
+ * The following guidelines may help when porting existing OS-specific code
+ * to use libserialport.
+ *
+ * ### Porting from Unix-like systems ###
+ *
+ * There are two main differences to note when porting code written for Unix.
+ *
+ * The first is that Unix traditionally provides a wide range of functionality
+ * for dealing with serial devices at the OS level; this is exposed through the
+ * termios API and dates to the days when serial terminals were common. If your
+ * code relies on many of these facilities you will need to adapt it, because
+ * libserialport provides only a raw binary channel with no special handling.
+ *
+ * The second relates to blocking versus non-blocking I/O behaviour. In
+ * Unix-like systems this is normally specified by setting the O_NONBLOCK
+ * flag on the file descriptor, affecting the semantics of subsequent read()
+ * and write() calls.
+ *
+ * In libserialport, blocking and nonblocking operations are both available at
+ * any time. If your existing code ѕets O_NONBLOCK, you should use
+ * sp_nonblocking_read() and sp_nonblocking_write() to get the same behaviour
+ * as your existing read() and write() calls. If it does not, you should use
+ * sp_blocking_read() and sp_blocking_write() instead. You may also find
+ * sp_blocking_read_next() useful, which reproduces the semantics of a blocking
+ * read() with VTIME = 0 and VMIN = 1 set in termios.
+ *
+ * Finally, you should take care if your program uses custom signal handlers.
+ * The blocking calls provided by libserialport will restart system calls that
+ * return with EINTR, so you will need to make your own arrangements if you
+ * need to interrupt blocking operations when your signal handlers are called.
+ * This is not an issue if you only use the default handlers.
+ *
+ * ### Porting from Windows ###
+ *
+ * The main consideration when porting from Windows is that there is no
+ * direct equivalent for overlapped I/O operations.
+ *
+ * If your program does not use overlapped I/O, you can simply use
+ * sp_blocking_read() and sp_blocking_write() as direct equivalents for
+ * ReadFile() and WriteFile(). You may also find sp_blocking_read_next()
+ * useful, which reproduces the special semantics of ReadFile() with
+ * ReadIntervalTimeout and ReadTotalTimeoutMultiplier set to MAXDWORD
+ * and 0 < ReadTotalTimeoutConstant < MAXDWORD.
+ *
+ * If your program makes use of overlapped I/O to continue work while a serial
+ * operation is in progress, then you can achieve the same results using
+ * sp_nonblocking_read() and sp_nonblocking_write().
+ *
+ * Generally, overlapped I/O is combined with either waiting for completion
+ * once there is no more background work to do (using WaitForSingleObject() or
+ * WaitForMultipleObjects()), or periodically checking for completion with
+ * GetOverlappedResult(). If the aim is to start a new operation for further
+ * data once the previous one has completed, you can instead simply call the
+ * nonblocking functions again with the next data. If you need to wait for
+ * completion, use sp_wait() to determine when the port is ready to send or
+ * receive further data.
  */
 
 #ifndef LIBSERIALPORT_LIBSERIALPORT_H
@@ -283,8 +456,10 @@ struct sp_event_set {
  *
  * The result should be freed after use by calling sp_free_port().
  *
- * If any error is returned, the variable pointed to by port_ptr will be set
- * to NULL. Otherwise, it will be set to point to the newly allocated port.
+ * @param[in] portname The OS-specific name of a serial port. Must not be NULL.
+ * @param[out] port_ptr If any error is returned, the variable pointed to by
+ *                      port_ptr will be set to NULL. Otherwise, it will be set
+ *                      to point to the newly allocated port. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -295,6 +470,8 @@ enum sp_return sp_get_port_by_name(const char *portname, struct sp_port **port_p
 /**
  * Free a port structure obtained from sp_get_port_by_name() or sp_copy_port().
  *
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ *
  * @since 0.1.0
  */
 void sp_free_port(struct sp_port *port);
@@ -310,8 +487,9 @@ void sp_free_port(struct sp_port *port);
  * If a port from the list is to be used after freeing the list, it must be
  * copied first using sp_copy_port().
  *
- * If any error is returned, the variable pointed to by list_ptr will be set
- * to NULL. Otherwise, it will be set to point to the newly allocated array.
+ * @param[out] list_ptr If any error is returned, the variable pointed to by
+ *                      list_ptr will be set to NULL. Otherwise, it will be set
+ *                      to point to the newly allocated array. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -320,15 +498,17 @@ void sp_free_port(struct sp_port *port);
 enum sp_return sp_list_ports(struct sp_port ***list_ptr);
 
 /**
- * Make a new copy of a sp_port structure.
+ * Make a new copy of an sp_port structure.
  *
  * The user should allocate a variable of type "struct sp_port *" and pass a
  * pointer to this to receive the result.
  *
  * The copy should be freed after use by calling sp_free_port().
  *
- * If any error is returned, the variable pointed to by copy_ptr will be set
- * to NULL. Otherwise, it will be set to point to the newly allocated copy.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] copy_ptr If any error is returned, the variable pointed to by
+ *                      copy_ptr will be set to NULL. Otherwise, it will be set
+ *                      to point to the newly allocated copy. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -342,6 +522,8 @@ enum sp_return sp_copy_port(const struct sp_port *port, struct sp_port **copy_pt
  * This will also free all the sp_port structures referred to from the list;
  * any that are to be retained must be copied first using sp_copy_port().
  *
+ * @param[in] ports Pointer to a list of port structures. Must not be NULL.
+ *
  * @since 0.1.0
  */
 void sp_free_port_list(struct sp_port **ports);
@@ -358,8 +540,8 @@ void sp_free_port_list(struct sp_port **ports);
 /**
  * Open the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param flags Flags to use when opening the serial port.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] flags Flags to use when opening the serial port.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -370,6 +552,8 @@ enum sp_return sp_open(struct sp_port *port, enum sp_mode flags);
 /**
  * Close the specified serial port.
  *
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ *
  * @return SP_OK upon success, a negative error code otherwise.
  *
  * @since 0.1.0
@@ -383,11 +567,11 @@ enum sp_return sp_close(struct sp_port *port);
  * current operating system; e.g. for Windows it will usually be a "COMn"
  * device name, and for Unix it will be a device path beginning with "/dev/".
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port name, or NULL if an invalid port is passed. The name
- * string is part of the port structure and may not be used after the
- * port structure has been freed.
+ *         string is part of the port structure and may not be used after
+ *         the port structure has been freed.
  *
  * @since 0.1.0
  */
@@ -396,33 +580,35 @@ char *sp_get_port_name(const struct sp_port *port);
 /**
  * Get a description for a port, to present to end user.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port description, or NULL if an invalid port is passed.
- * The description string is part of the port structure and may not be used
- * after the port structure has been freed.
+ *         The description string is part of the port structure and may not
+ *         be used after the port structure has been freed.
  *
  * @since 0.1.1
  */
-char *sp_get_port_description(struct sp_port *port);
+char *sp_get_port_description(const struct sp_port *port);
 
 /**
  * Get the transport type used by a port.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port transport type.
  *
  * @since 0.1.1
  */
-enum sp_transport sp_get_port_transport(struct sp_port *port);
+enum sp_transport sp_get_port_transport(const struct sp_port *port);
 
 /**
  * Get the USB bus number and address on bus of a USB serial adapter port.
  *
- * @param port Pointer to port structure.
- * @param usb_bus Pointer to variable to store USB bus.
- * @param usb_address Pointer to variable to store USB address
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] usb_bus Pointer to a variable to store the USB bus.
+ *                     Can be NULL (in that case it will be ignored).
+ * @param[out] usb_address Pointer to a variable to store the USB address.
+ *                         Can be NULL (in that case it will be ignored).
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -434,9 +620,11 @@ enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
 /**
  * Get the USB Vendor ID and Product ID of a USB serial adapter port.
  *
- * @param port Pointer to port structure.
- * @param usb_vid Pointer to variable to store USB VID.
- * @param usb_pid Pointer to variable to store USB PID
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] usb_vid Pointer to a variable to store the USB VID.
+ *                     Can be NULL (in that case it will be ignored).
+ * @param[out] usb_pid Pointer to a variable to store the USB PID.
+ *                     Can be NULL (in that case it will be ignored).
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -447,11 +635,11 @@ enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid,
 /**
  * Get the USB manufacturer string of a USB serial adapter port.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port manufacturer string, or NULL if an invalid port is passed.
- * The manufacturer string is part of the port structure and may not be used
- * after the port structure has been freed.
+ *         The manufacturer string is part of the port structure and may not
+ *         be used after the port structure has been freed.
  *
  * @since 0.1.1
  */
@@ -460,11 +648,11 @@ char *sp_get_port_usb_manufacturer(const struct sp_port *port);
 /**
  * Get the USB product string of a USB serial adapter port.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port product string, or NULL if an invalid port is passed.
- * The product string is part of the port structure and may not be used
- * after the port structure has been freed.
+ *         The product string is part of the port structure and may not be
+ *         used after the port structure has been freed.
  *
  * @since 0.1.1
  */
@@ -473,11 +661,11 @@ char *sp_get_port_usb_product(const struct sp_port *port);
 /**
  * Get the USB serial number string of a USB serial adapter port.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port serial number, or NULL if an invalid port is passed.
- * The serial number string is part of the port structure and may not be used
- * after the port structure has been freed.
+ *         The serial number string is part of the port structure and may
+ *         not be used after the port structure has been freed.
  *
  * @since 0.1.1
  */
@@ -486,11 +674,11 @@ char *sp_get_port_usb_serial(const struct sp_port *port);
 /**
  * Get the MAC address of a Bluetooth serial adapter port.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return The port MAC address, or NULL if an invalid port is passed.
- * The MAC address string is part of the port structure and may not be used
- * after the port structure has been freed.
+ *         The MAC address string is part of the port structure and may not
+ *         be used after the port structure has been freed.
  *
  * @since 0.1.1
  */
@@ -516,6 +704,12 @@ char *sp_get_port_bluetooth_address(const struct sp_port *port);
  *          that direct usage of the OS handle will not conflict with the
  *          library's own usage of the port. Be careful.
  *
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] result_ptr If any error is returned, the variable pointed to by
+ *                        result_ptr will have unknown contents and should not
+ *                        be used. Otherwise, it will be set to point to the
+ *                        OS handle. Must not be NULL.
+ *
  * @return SP_OK upon success, a negative error code otherwise.
  *
  * @since 0.1.0
@@ -534,17 +728,20 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
 /**
  * Allocate a port configuration structure.
  *
- * The user should allocate a variable of type "struct sp_config *" and pass a
- * pointer to this to receive the result. The variable will be updated to
- * point to the new configuration structure. The structure is opaque and must
- * be accessed via the functions provided.
+ * The user should allocate a variable of type "struct sp_port_config *" and
+ * pass a pointer to this to receive the result. The variable will be updated
+ * to point to the new configuration structure. The structure is opaque and
+ * must be accessed via the functions provided.
  *
  * All parameters in the structure will be initialised to special values which
  * are ignored by sp_set_config().
  *
  * The structure should be freed after use by calling sp_free_config().
  *
- * @param config_ptr Pointer to variable to receive result.
+ * @param[out] config_ptr If any error is returned, the variable pointed to by
+ *                        config_ptr will be set to NULL. Otherwise, it will
+ *                        be set to point to the allocated config structure.
+ *                        Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -555,7 +752,7 @@ enum sp_return sp_new_config(struct sp_port_config **config_ptr);
 /**
  * Free a port configuration structure.
  *
- * @param config Pointer to configuration structure.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
  *
  * @since 0.1.0
  */
@@ -572,6 +769,11 @@ void sp_free_config(struct sp_port_config *config);
  * supported by libserialport, will be set to special values that are
  * ignored by sp_set_config().
  *
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] config Pointer to a configuration structure that will hold
+ *                    the result. Upon errors the contents of the config
+ *                    struct will not be changed. Must not be NULL.
+ *
  * @return SP_OK upon success, a negative error code otherwise.
  *
  * @since 0.1.0
@@ -585,6 +787,12 @@ enum sp_return sp_get_config(struct sp_port *port, struct sp_port_config *config
  * -1, but see the documentation for each field). These values will be ignored
  * and the corresponding setting left unchanged on the port.
  *
+ * Upon errors, the configuration of the serial port is unknown since
+ * partial/incomplete config updates may have happened.
+ *
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ *
  * @return SP_OK upon success, a negative error code otherwise.
  *
  * @since 0.1.0
@@ -594,8 +802,8 @@ enum sp_return sp_set_config(struct sp_port *port, const struct sp_port_config *
 /**
  * Set the baud rate for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param baudrate Baud rate in bits per second.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] baudrate Baud rate in bits per second.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -606,11 +814,11 @@ enum sp_return sp_set_baudrate(struct sp_port *port, int baudrate);
 /**
  * Get the baud rate from a port configuration.
  *
- * The user should allocate a variable of type int and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type int and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param baudrate_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] baudrate_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -621,8 +829,8 @@ enum sp_return sp_get_config_baudrate(const struct sp_port_config *config, int *
 /**
  * Set the baud rate in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param baudrate Baud rate in bits per second, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] baudrate Baud rate in bits per second, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -633,8 +841,8 @@ enum sp_return sp_set_config_baudrate(struct sp_port_config *config, int baudrat
 /**
  * Set the data bits for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param bits Number of data bits.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] bits Number of data bits.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -645,11 +853,11 @@ enum sp_return sp_set_bits(struct sp_port *port, int bits);
 /**
  * Get the data bits from a port configuration.
  *
- * The user should allocate a variable of type int and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type int and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param bits_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] bits_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -660,8 +868,8 @@ enum sp_return sp_get_config_bits(const struct sp_port_config *config, int *bits
 /**
  * Set the data bits in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param bits Number of data bits, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] bits Number of data bits, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -672,8 +880,8 @@ enum sp_return sp_set_config_bits(struct sp_port_config *config, int bits);
 /**
  * Set the parity setting for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param parity Parity setting.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] parity Parity setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -684,11 +892,11 @@ enum sp_return sp_set_parity(struct sp_port *port, enum sp_parity parity);
 /**
  * Get the parity setting from a port configuration.
  *
- * The user should allocate a variable of type enum sp_parity and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_parity and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param parity_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] parity_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -699,8 +907,8 @@ enum sp_return sp_get_config_parity(const struct sp_port_config *config, enum sp
 /**
  * Set the parity setting in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param parity Parity setting, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] parity Parity setting, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -711,8 +919,8 @@ enum sp_return sp_set_config_parity(struct sp_port_config *config, enum sp_parit
 /**
  * Set the stop bits for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param stopbits Number of stop bits.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] stopbits Number of stop bits.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -723,11 +931,11 @@ enum sp_return sp_set_stopbits(struct sp_port *port, int stopbits);
 /**
  * Get the stop bits from a port configuration.
  *
- * The user should allocate a variable of type int and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type int and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param stopbits_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] stopbits_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -738,8 +946,8 @@ enum sp_return sp_get_config_stopbits(const struct sp_port_config *config, int *
 /**
  * Set the stop bits in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param stopbits Number of stop bits, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] stopbits Number of stop bits, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -750,8 +958,8 @@ enum sp_return sp_set_config_stopbits(struct sp_port_config *config, int stopbit
 /**
  * Set the RTS pin behaviour for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param rts RTS pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] rts RTS pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -762,11 +970,11 @@ enum sp_return sp_set_rts(struct sp_port *port, enum sp_rts rts);
 /**
  * Get the RTS pin behaviour from a port configuration.
  *
- * The user should allocate a variable of type enum sp_rts and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_rts and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param rts_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] rts_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -777,8 +985,8 @@ enum sp_return sp_get_config_rts(const struct sp_port_config *config, enum sp_rt
 /**
  * Set the RTS pin behaviour in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param rts RTS pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] rts RTS pin mode, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -789,8 +997,8 @@ enum sp_return sp_set_config_rts(struct sp_port_config *config, enum sp_rts rts)
 /**
  * Set the CTS pin behaviour for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param cts CTS pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] cts CTS pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -801,11 +1009,11 @@ enum sp_return sp_set_cts(struct sp_port *port, enum sp_cts cts);
 /**
  * Get the CTS pin behaviour from a port configuration.
  *
- * The user should allocate a variable of type enum sp_cts and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_cts and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param cts_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] cts_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -816,8 +1024,8 @@ enum sp_return sp_get_config_cts(const struct sp_port_config *config, enum sp_ct
 /**
  * Set the CTS pin behaviour in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param cts CTS pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] cts CTS pin mode, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -828,8 +1036,8 @@ enum sp_return sp_set_config_cts(struct sp_port_config *config, enum sp_cts cts)
 /**
  * Set the DTR pin behaviour for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param dtr DTR pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] dtr DTR pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -840,11 +1048,11 @@ enum sp_return sp_set_dtr(struct sp_port *port, enum sp_dtr dtr);
 /**
  * Get the DTR pin behaviour from a port configuration.
  *
- * The user should allocate a variable of type enum sp_dtr and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_dtr and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param dtr_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] dtr_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -855,8 +1063,8 @@ enum sp_return sp_get_config_dtr(const struct sp_port_config *config, enum sp_dt
 /**
  * Set the DTR pin behaviour in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param dtr DTR pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] dtr DTR pin mode, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -867,8 +1075,8 @@ enum sp_return sp_set_config_dtr(struct sp_port_config *config, enum sp_dtr dtr)
 /**
  * Set the DSR pin behaviour for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param dsr DSR pin mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] dsr DSR pin mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -879,11 +1087,11 @@ enum sp_return sp_set_dsr(struct sp_port *port, enum sp_dsr dsr);
 /**
  * Get the DSR pin behaviour from a port configuration.
  *
- * The user should allocate a variable of type enum sp_dsr and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_dsr and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param dsr_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] dsr_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -894,8 +1102,8 @@ enum sp_return sp_get_config_dsr(const struct sp_port_config *config, enum sp_ds
 /**
  * Set the DSR pin behaviour in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param dsr DSR pin mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] dsr DSR pin mode, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -906,8 +1114,8 @@ enum sp_return sp_set_config_dsr(struct sp_port_config *config, enum sp_dsr dsr)
 /**
  * Set the XON/XOFF configuration for the specified serial port.
  *
- * @param port Pointer to port structure.
- * @param xon_xoff XON/XOFF mode.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] xon_xoff XON/XOFF mode.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -918,11 +1126,11 @@ enum sp_return sp_set_xon_xoff(struct sp_port *port, enum sp_xonxoff xon_xoff);
 /**
  * Get the XON/XOFF configuration from a port configuration.
  *
- * The user should allocate a variable of type enum sp_xonxoff and pass a pointer to this
- * to receive the result.
+ * The user should allocate a variable of type enum sp_xonxoff and
+ * pass a pointer to this to receive the result.
  *
- * @param config Pointer to configuration structure.
- * @param xon_xoff_ptr Pointer to variable to store result.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[out] xon_xoff_ptr Pointer to a variable to store the result. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -933,8 +1141,8 @@ enum sp_return sp_get_config_xon_xoff(const struct sp_port_config *config, enum
 /**
  * Set the XON/XOFF configuration in a port configuration.
  *
- * @param config Pointer to configuration structure.
- * @param xon_xoff XON/XOFF mode, or -1 to retain current setting.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] xon_xoff XON/XOFF mode, or -1 to retain the current setting.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -950,8 +1158,8 @@ enum sp_return sp_set_config_xon_xoff(struct sp_port_config *config, enum sp_xon
  * type. For more fine-grained control of these settings, use their
  * individual configuration functions.
  *
- * @param config Pointer to configuration structure.
- * @param flowcontrol Flow control setting to use.
+ * @param[in] config Pointer to a configuration structure. Must not be NULL.
+ * @param[in] flowcontrol Flow control setting to use.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -967,8 +1175,8 @@ enum sp_return sp_set_config_flowcontrol(struct sp_port_config *config, enum sp_
  * type. For more fine-grained control of these settings, use their
  * individual configuration functions.
  *
- * @param port Pointer to port structure.
- * @param flowcontrol Flow control setting to use.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] flowcontrol Flow control setting to use.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -999,10 +1207,10 @@ enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flow
  *          sp_get_port_handle() and use this to call select() or pselect(),
  *          with appropriate arrangements to return if a signal is received.
  *
- * @param port Pointer to port structure.
- * @param buf Buffer in which to store the bytes read.
- * @param count Requested number of bytes to read.
- * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
+ * @param[in] count Requested number of bytes to read.
+ * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
  *
  * @return The number of bytes read on success, or a negative error code. If
  *         the number of bytes returned is less than that requested, the
@@ -1012,14 +1220,42 @@ enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flow
  *
  * @since 0.1.0
  */
-enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout);
+enum sp_return sp_blocking_read(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms);
+
+/**
+ * Read bytes from the specified serial port, returning as soon as any data is
+ * available.
+ *
+ * @warning If your program runs on Unix, defines its own signal handlers, and
+ *          needs to abort blocking reads when these are called, then you
+ *          should not use this function. It repeats system calls that return
+ *          with EINTR. To be able to abort a read from a signal handler, you
+ *          should implement your own blocking read using sp_nonblocking_read()
+ *          together with a blocking method that makes sense for your program.
+ *          E.g. you can obtain the file descriptor for an open port using
+ *          sp_get_port_handle() and use this to call select() or pselect(),
+ *          with appropriate arrangements to return if a signal is received.
+ *
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
+ * @param[in] count Maximum number of bytes to read. Must not be zero.
+ * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
+ *
+ * @return The number of bytes read on success, or a negative error code. If
+ *         the result is zero, the timeout was reached before any bytes were
+ *         available. If timeout_ms is zero, the function will always return
+ *         either at least one byte, or a negative error code.
+ *
+ * @since 0.1.1
+ */
+enum sp_return sp_blocking_read_next(struct sp_port *port, void *buf, size_t count, unsigned int timeout_ms);
 
 /**
  * Read bytes from the specified serial port, without blocking.
  *
- * @param port Pointer to port structure.
- * @param buf Buffer in which to store the bytes read.
- * @param count Maximum number of bytes to read.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] buf Buffer in which to store the bytes read. Must not be NULL.
+ * @param[in] count Maximum number of bytes to read.
  *
  * @return The number of bytes read on success, or a negative error code. The
  *         number of bytes returned may be any number from zero to the maximum
@@ -1048,10 +1284,10 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count
  *          sp_get_port_handle() and use this to call select() or pselect(),
  *          with appropriate arrangements to return if a signal is received.
  *
- * @param port Pointer to port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Requested number of bytes to write.
- * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
+ * @param[in] count Requested number of bytes to write.
+ * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
  *
  * @return The number of bytes written on success, or a negative error code.
  *         If the number of bytes returned is less than that requested, the
@@ -1063,7 +1299,7 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count
  *
  * @since 0.1.0
  */
-enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout);
+enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t count, unsigned int timeout_ms);
 
 /**
  * Write bytes to the specified serial port, without blocking.
@@ -1074,9 +1310,9 @@ enum sp_return sp_blocking_write(struct sp_port *port, const void *buf, size_t c
  * been transmitted, use the sp_output_waiting() function. To wait until all
  * written bytes have actually been transmitted, use the sp_drain() function.
  *
- * @param port Pointer to port structure.
- * @param buf Buffer containing the bytes to write.
- * @param count Maximum number of bytes to write.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] buf Buffer containing the bytes to write. Must not be NULL.
+ * @param[in] count Maximum number of bytes to write.
  *
  * @return The number of bytes written on success, or a negative error code.
  *         The number of bytes returned may be any number from zero to the
@@ -1089,7 +1325,7 @@ enum sp_return sp_nonblocking_write(struct sp_port *port, const void *buf, size_
 /**
  * Gets the number of bytes waiting in the input buffer.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return Number of bytes waiting on success, a negative error code otherwise.
  *
@@ -1100,7 +1336,7 @@ enum sp_return sp_input_waiting(struct sp_port *port);
 /**
  * Gets the number of bytes waiting in the output buffer.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return Number of bytes waiting on success, a negative error code otherwise.
  *
@@ -1111,8 +1347,8 @@ enum sp_return sp_output_waiting(struct sp_port *port);
 /**
  * Flush serial port buffers. Data in the selected buffer(s) is discarded.
  *
- * @param port Pointer to port structure.
- * @param buffers Which buffer(s) to flush.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] buffers Which buffer(s) to flush.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -1130,7 +1366,7 @@ enum sp_return sp_flush(struct sp_port *port, enum sp_buffer buffers);
  *          signal handler, you would need to implement your own blocking
  *          drain by polling the result of sp_output_waiting().
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -1156,6 +1392,10 @@ enum sp_return sp_drain(struct sp_port *port);
  *
  * The result should be freed after use by calling sp_free_event_set().
  *
+ * @param[out] result_ptr If any error is returned, the variable pointed to by
+ *                        result_ptr will be set to NULL. Otherwise, it will
+ *                        be set to point to the event set. Must not be NULL.
+ *
  * @return SP_OK upon success, a negative error code otherwise.
  *
  * @since 0.1.0
@@ -1171,9 +1411,9 @@ enum sp_return sp_new_event_set(struct sp_event_set **result_ptr);
  * After the port is closed or the port structure freed, the results may
  * no longer be valid.
  *
- * @param event_set Event set to update.
- * @param port Pointer to port structure.
- * @param mask Bitmask of events to be waited for.
+ * @param[in,out] event_set Event set to update. Must not be NULL.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[in] mask Bitmask of events to be waited for.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -1185,18 +1425,20 @@ enum sp_return sp_add_port_events(struct sp_event_set *event_set,
 /**
  * Wait for any of a set of events to occur.
  *
- * @param event_set Event set to wait on.
- * @param timeout Timeout in milliseconds, or zero to wait indefinitely.
+ * @param[in] event_set Event set to wait on. Must not be NULL.
+ * @param[in] timeout_ms Timeout in milliseconds, or zero to wait indefinitely.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
  * @since 0.1.0
  */
-enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout);
+enum sp_return sp_wait(struct sp_event_set *event_set, unsigned int timeout_ms);
 
 /**
  * Free a structure allocated by sp_new_event_set().
  *
+ * @param[in] event_set Event set to free. Must not be NULL.
+ *
  * @since 0.1.0
  */
 void sp_free_event_set(struct sp_event_set *event_set);
@@ -1219,8 +1461,9 @@ void sp_free_event_set(struct sp_event_set *event_set);
  * in which individual signals can be checked by bitwise OR with values of
  * the sp_signal enum.
  *
- * @param port Pointer to port structure.
- * @param signal_mask Pointer to variable to receive result.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
+ * @param[out] signal_mask Pointer to a variable to receive the result.
+ *                         Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -1231,7 +1474,7 @@ enum sp_return sp_get_signals(struct sp_port *port, enum sp_signal *signal_mask)
 /**
  * Put the port transmit line into the break state.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -1242,7 +1485,7 @@ enum sp_return sp_start_break(struct sp_port *port);
 /**
  * Take the port transmit line out of the break state.
  *
- * @param port Pointer to port structure.
+ * @param[in] port Pointer to a port structure. Must not be NULL.
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
@@ -1265,6 +1508,8 @@ enum sp_return sp_end_break(struct sp_port *port);
  *
  * In order to obtain the correct result, this function should be called
  * straight after the failure, before executing any other system operations.
+ * The result is thread-specific, and only valid when called immediately
+ * after a previous call returning SP_ERR_FAIL.
  *
  * @return The system's numeric code for the error that caused the last
  *         operation to fail.
@@ -1278,6 +1523,8 @@ int sp_last_error_code(void);
  *
  * In order to obtain the correct result, this function should be called
  * straight after the failure, before executing other system operations.
+ * The result is thread-specific, and only valid when called immediately
+ * after a previous call returning SP_ERR_FAIL.
  *
  * @return The system's message for the error that caused the last
  *         operation to fail. This string may be allocated by the function,
@@ -1290,6 +1537,8 @@ char *sp_last_error_message(void);
 /**
  * Free an error message returned by sp_last_error_message().
  *
+ * @param[in] message The error message string to free. Must not be NULL.
+ *
  * @since 0.1.0
  */
 void sp_free_error_message(char *message);
@@ -1306,6 +1555,9 @@ void sp_free_error_message(char *message);
  *
  * The default handler is sp_default_debug_handler().
  *
+ * @param[in] handler The handler function to use. Can be NULL (in that case
+ *                    all debug messages will be ignored).
+ *
  * @since 0.1.0
  */
 void sp_set_debug_handler(void (*handler)(const char *format, ...));
@@ -1317,6 +1569,9 @@ void sp_set_debug_handler(void (*handler)(const char *format, ...));
  * environment variable LIBSERIALPORT_DEBUG is set. Otherwise, they are
  * ignored.
  *
+ * @param[in] format The format string to use. Must not be NULL.
+ * @param[in] ... The variable length argument list to use.
+ *
  * @since 0.1.0
  */
 void sp_default_debug_handler(const char *format, ...);
@@ -1348,32 +1603,32 @@ void sp_default_debug_handler(const char *format, ...);
  */
 
 /** The libserialport package 'major' version number. */
-#define SP_PACKAGE_VERSION_MAJOR @SP_PACKAGE_VERSION_MAJOR@
+#undef SP_PACKAGE_VERSION_MAJOR
 
 /** The libserialport package 'minor' version number. */
-#define SP_PACKAGE_VERSION_MINOR @SP_PACKAGE_VERSION_MINOR@
+#undef SP_PACKAGE_VERSION_MINOR
 
 /** The libserialport package 'micro' version number. */
-#define SP_PACKAGE_VERSION_MICRO @SP_PACKAGE_VERSION_MICRO@
+#undef SP_PACKAGE_VERSION_MICRO
 
 /** The libserialport package version ("major.minor.micro") as string. */
-#define SP_PACKAGE_VERSION_STRING "@SP_PACKAGE_VERSION@"
+#undef SP_PACKAGE_VERSION_STRING
 
 /*
  * Library/libtool version macros (can be used for conditional compilation).
  */
 
 /** The libserialport libtool 'current' version number. */
-#define SP_LIB_VERSION_CURRENT @SP_LIB_VERSION_CURRENT@
+#undef SP_LIB_VERSION_CURRENT
 
 /** The libserialport libtool 'revision' version number. */
-#define SP_LIB_VERSION_REVISION @SP_LIB_VERSION_REVISION@
+#undef SP_LIB_VERSION_REVISION
 
 /** The libserialport libtool 'age' version number. */
-#define SP_LIB_VERSION_AGE @SP_LIB_VERSION_AGE@
+#undef SP_LIB_VERSION_AGE
 
 /** The libserialport libtool version ("current:revision:age") as string. */
-#define SP_LIB_VERSION_STRING "@SP_LIB_VERSION@"
+#undef SP_LIB_VERSION_STRING
 
 /**
  * Get the major libserialport package version number.