libserialport.h.in: Add @since tags for new enums.

[libserialport.git] / libserialport.h.in

diff --git a/libserialport.h.in b/libserialport.h.in
index 44c6684fb11bf07fd9330770f148f52ec1c7d67d..d945d4f06ff096c173c18a7f1f58fb90cbff02ec 100644 (file)
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -109,7 +109,7 @@ enum sp_mode {
        SP_MODE_READ = 1,
        /** Open port for write access. */
        SP_MODE_WRITE = 2,
-       /** Open port for read and write access. */
+       /** Open port for read and write access. @since 0.1.1 */
        SP_MODE_READ_WRITE = 3
 };
 
@@ -231,13 +231,17 @@ enum sp_signal {
        SP_SIG_RI = 8
 };
 
-/** Transport types. */
+/**
+ * Transport types.
+ *
+ * @since 0.1.1
+ */
 enum sp_transport {
-       /** Native platform serial port. */
+       /** Native platform serial port. @since 0.1.1 */
        SP_TRANSPORT_NATIVE,
-       /** USB serial port adapter. */
+       /** USB serial port adapter. @since 0.1.1 */
        SP_TRANSPORT_USB,
-       /** Bluetooth serial port adapter. */
+       /** Bluetooth serial port adapter. @since 0.1.1 */
        SP_TRANSPORT_BLUETOOTH
 };
 
@@ -401,7 +405,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);
 
@@ -412,7 +416,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);
 
@@ -425,7 +429,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);
@@ -439,7 +443,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);
 
@@ -452,7 +456,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);
 
@@ -465,7 +469,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);
 
@@ -478,7 +482,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);
 
@@ -491,7 +495,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);