X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libserialport.h.in;h=d71ba7f4a86db8343971967b5925c5795857cabf;hb=0a1ab8bf8f4c76c809c63ff26d0aa4a5af418728;hp=41948c1828eee3bab22fdc1e60187233489e88c8;hpb=1a2a1544d73ed288732b409eef95502228e1ed0a;p=libserialport.git diff --git a/libserialport.h.in b/libserialport.h.in index 41948c1..d71ba7f 100644 --- a/libserialport.h.in +++ b/libserialport.h.in @@ -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; /**