1
0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00

Document enumeration functions.

This commit is contained in:
Martin Ling 2013-04-28 12:36:02 +01:00 committed by Uwe Hermann
parent 3b63f34dcb
commit 68ab64ccdc

View File

@ -68,6 +68,11 @@ fail:
return NULL; return NULL;
} }
/**
* List the serial ports available on the system.
*
* @return A null-terminated array of port name strings.
*/
char **sp_list_ports(void) char **sp_list_ports(void)
{ {
char **list = NULL; char **list = NULL;
@ -197,6 +202,9 @@ out:
#endif #endif
} }
/**
* Free a port list returned by sp_list_ports.
*/
void sp_free_port_list(char **list) void sp_free_port_list(char **list)
{ {
unsigned int i; unsigned int i;