Set package version to 0.1.1, use "@since 0.1.1" Doxygen tags.

[libserialport.git] / libserialport.h.in

diff --git a/libserialport.h.in b/libserialport.h.in
index 51d9afe6c1449c5a57d69f33da1daffd329b7cd6..88628fcc9881307b5fdb5e6a9963077fb920c0f8 100644 (file)
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -95,7 +95,7 @@ enum sp_return {
        SP_OK = 0,
        /** Invalid arguments were passed to the function. */
        SP_ERR_ARG = -1,
-       /** A system error occured while executing the operation. */
+       /** A system error occurred while executing the operation. */
        SP_ERR_FAIL = -2,
        /** A memory allocation failed while executing the operation. */
        SP_ERR_MEM = -3,
@@ -108,16 +108,18 @@ enum sp_mode {
        /** Open port for read access. */
        SP_MODE_READ = 1,
        /** Open port for write access. */
-       SP_MODE_WRITE = 2
+       SP_MODE_WRITE = 2,
+       /** Open port for read and write access. */
+       SP_MODE_READ_WRITE = 3
 };
 
 /** 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 occured. */
+       /** Error occurred. */
        SP_EVENT_ERROR = 4
 };
 
@@ -235,7 +237,7 @@ enum sp_transport {
        SP_TRANSPORT_NATIVE,
        /** USB serial port adapter. */
        SP_TRANSPORT_USB,
-       /** Bluetooh serial port adapter. */
+       /** Bluetooth serial port adapter. */
        SP_TRANSPORT_BLUETOOTH
 };
 
@@ -265,9 +267,12 @@ struct sp_event_set {
 };
 
 /**
-@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.
@@ -342,7 +347,10 @@ void sp_free_port_list(struct sp_port **ports);
 
 /**
  * @}
- * @defgroup Ports Opening, closing and querying ports
+ * @defgroup Ports Port handling
+ *
+ * Opening, closing and querying ports.
+ *
  * @{
  */
 
@@ -393,7 +401,7 @@ char *sp_get_port_name(const struct sp_port *port);
  * The description string is part of the port structure and may not be used
  * after the port structure has been freed.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 char *sp_get_port_description(struct sp_port *port);
 
@@ -404,7 +412,7 @@ char *sp_get_port_description(struct sp_port *port);
  *
  * @return The port transport type.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 enum sp_transport sp_get_port_transport(struct sp_port *port);
 
@@ -417,7 +425,7 @@ enum sp_transport sp_get_port_transport(struct sp_port *port);
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
                                            int *usb_bus, int *usb_address);
@@ -431,7 +439,7 @@ enum sp_return sp_get_port_usb_bus_address(const struct sp_port *port,
  *
  * @return SP_OK upon success, a negative error code otherwise.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid, int *usb_pid);
 
@@ -444,7 +452,7 @@ enum sp_return sp_get_port_usb_vid_pid(const struct sp_port *port, int *usb_vid,
  * The manufacturer string is part of the port structure and may not be used
  * after the port structure has been freed.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 char *sp_get_port_usb_manufacturer(const struct sp_port *port);
 
@@ -457,7 +465,7 @@ char *sp_get_port_usb_manufacturer(const struct sp_port *port);
  * The product string is part of the port structure and may not be used
  * after the port structure has been freed.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 char *sp_get_port_usb_product(const struct sp_port *port);
 
@@ -470,7 +478,7 @@ char *sp_get_port_usb_product(const struct sp_port *port);
  * The serial number string is part of the port structure and may not be used
  * after the port structure has been freed.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 char *sp_get_port_usb_serial(const struct sp_port *port);
 
@@ -483,7 +491,7 @@ char *sp_get_port_usb_serial(const struct sp_port *port);
  * The MAC address string is part of the port structure and may not be used
  * after the port structure has been freed.
  *
- * @since 0.2.0
+ * @since 0.1.1
  */
 char *sp_get_port_bluetooth_address(const struct sp_port *port);
 
@@ -515,7 +523,10 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
 
 /**
  * @}
- * @defgroup Configuration Setting port parameters
+ *
+ * @defgroup Configuration Configuration
+ *
+ * Setting and querying serial port parameters.
  * @{
  */
 
@@ -966,9 +977,13 @@ enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontrol flow
 
 /**
  * @}
- * @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.
@@ -1043,7 +1058,7 @@ enum sp_return sp_nonblocking_read(struct sp_port *port, void *buf, size_t count
  *         written. If timeout is zero, the function will always return
  *         either the requested number of bytes or a negative error code. In
  *         the event of an error there is no way to determine how many bytes
- *         were sent before the error occured.
+ *         were sent before the error occurred.
  *
  * @since 0.1.0
  */
@@ -1124,7 +1139,11 @@ enum sp_return sp_drain(struct sp_port *port);
 
 /**
  * @}
- * @defgroup Waiting Waiting for events
+ *
+ * @defgroup Waiting Waiting
+ *
+ * Waiting for events and timeout handling.
+ *
  * @{
  */
 
@@ -1183,7 +1202,11 @@ void sp_free_event_set(struct sp_event_set *event_set);
 
 /**
  * @}
- * @defgroup Signals Port signalling operations
+ *
+ * @defgroup Signals Signals
+ *
+ * Port signalling operations.
+ *
  * @{
  */
 
@@ -1228,9 +1251,13 @@ enum sp_return sp_end_break(struct sp_port *port);
 
 /**
  * @}
- * @defgroup Errors Obtaining error information
+ *
+ * @defgroup Errors Errors
+ *
+ * Obtaining error information.
+ *
  * @{
-*/
+ */
 
 /**
  * Get the error code for a failed operation.
@@ -1296,7 +1323,9 @@ void sp_default_debug_handler(const char *format, ...);
 /** @} */
 
 /**
- * @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