X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libserialport.h;h=7467f7438fb9fb878ccb817be4acce24f8779532;hb=4349b1f6a291c408782c77bdad01991755932f8f;hp=09af4ff0672f226958b013a954d329466d520354;hpb=6dba84477940e75c3ff13c84ce96610f657f50af;p=libserialport.git diff --git a/libserialport.h b/libserialport.h index 09af4ff..7467f74 100644 --- a/libserialport.h +++ b/libserialport.h @@ -68,6 +68,9 @@ * - @ref list_ports.c - Getting a list of ports present on the system. * - @ref port_info.c - Getting information on a particular serial port. * - @ref port_config.c - Accessing configuration settings of a port. + * - @ref send_receive.c - Sending and receiving data. + * - @ref await_events.c - Awaiting events on multiple ports. + * - @ref handle_errors.c - Handling errors returned from the library. * * These examples are linked with the API documentation. Each function * in the API reference includes links to where it is used in an example @@ -1287,6 +1290,8 @@ SP_API enum sp_return sp_set_flowcontrol(struct sp_port *port, enum sp_flowcontr * * Reading, writing, and flushing data. * + * See @ref send_receive.c for an example of sending and receiving data. + * * @{ */ @@ -1477,6 +1482,8 @@ SP_API enum sp_return sp_drain(struct sp_port *port); * * Waiting for events and timeout handling. * + * See @ref await_events.c for an example of awaiting events on multiple ports. + * * @{ */ @@ -1596,6 +1603,8 @@ SP_API enum sp_return sp_end_break(struct sp_port *port); * * Obtaining error information. * + * See @ref handle_errors.c for an example of error handling. + * * @{ */ @@ -1806,6 +1815,9 @@ SP_API const char *sp_get_lib_version_string(void); * @example list_ports.c Getting a list of ports present on the system. * @example port_info.c Getting information on a particular serial port. * @example port_config.c Accessing configuration settings of a port. + * @example send_receive.c Sending and receiving data. + * @example await_events.c Awaiting events on multiple ports. + * @example handle_errors.c Handling errors returned from the library. */ #ifdef __cplusplus