]> sigrok.org Git - libserialport.git/commitdiff
Minor Doxygen updates/fixes.
authorUwe Hermann <redacted>
Tue, 17 Dec 2013 21:31:12 +0000 (22:31 +0100)
committerUwe Hermann <redacted>
Tue, 17 Dec 2013 21:39:19 +0000 (22:39 +0100)
libserialport.h.in

index 41948c1828eee3bab22fdc1e60187233489e88c8..d71ba7f4a86db8343971967b5925c5795857cabf 100644 (file)
@@ -73,7 +73,7 @@
  *
  * 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_read() and sp_write().
+ * numeric result, e.g. sp_blocking_read() or sp_blocking_write().
  */
 
 #ifndef LIBSERIALPORT_LIBSERIALPORT_H
@@ -230,10 +230,16 @@ enum sp_signal {
        SP_SIG_RI = 8,
 };
 
-/** A serial port. */
+/**
+ * @struct sp_port
+ * An opaque structure representing a serial port.
+ */
 struct sp_port;
 
-/** Configuration for a serial port. */
+/**
+ * @struct sp_port_config
+ * An opaque structure representing the configuration for a serial port.
+ */
 struct sp_port_config;
 
 /**