/** Port events. */
enum sp_event {
- /* Data received and ready to read. */
+ /** Data received and ready to read. */
SP_EVENT_RX_READY = 1,
- /* Ready to transmit new data. */
+ /** Ready to transmit new data. */
SP_EVENT_TX_READY = 2,
- /* Error occurred. */
+ /** Error occurred. */
SP_EVENT_ERROR = 4
};
};
/**
-@defgroup Enumeration Port enumeration
-@{
-*/
+ * @defgroup Enumeration Port enumeration
+ *
+ * Enumerating the serial ports of a system.
+ *
+ * @{
+ */
/**
* Obtain a pointer to a new sp_port structure representing the named port.
/**
* @}
- * @defgroup Ports Opening, closing and querying ports
+ * @defgroup Ports Port handling
+ *
+ * Opening, closing and querying ports.
+ *
* @{
*/
/**
* @}
- * @defgroup Configuration Setting port parameters
+ *
+ * @defgroup Configuration Configuration
+ *
+ * Setting and querying serial port parameters.
* @{
*/
/**
* @}
- * @defgroup Data Reading, writing, and flushing data
+ *
+ * @defgroup Data Data handling
+ *
+ * Reading, writing, and flushing data.
+ *
* @{
-*/
+ */
/**
* Read bytes from the specified serial port, blocking until complete.
/**
* @}
- * @defgroup Waiting Waiting for events
+ *
+ * @defgroup Waiting Waiting
+ *
+ * Waiting for events and timeout handling.
+ *
* @{
*/
/**
* @}
- * @defgroup Signals Port signalling operations
+ *
+ * @defgroup Signals Signals
+ *
+ * Port signalling operations.
+ *
* @{
*/
/**
* @}
- * @defgroup Errors Obtaining error information
+ *
+ * @defgroup Errors Errors
+ *
+ * Obtaining error information.
+ *
* @{
-*/
+ */
/**
* Get the error code for a failed operation.
/** @} */
/**
- * @defgroup Versions Version number querying functions, definitions, and macros
+ * @defgroup Versions Versions
+ *
+ * Version number querying functions, definitions, and macros.
*
* This set of API calls returns two different version numbers related
* to libserialport. The "package version" is the release version number of the