From 68ab64ccdcb6c0a845dce417c18a74fcf284f9d2 Mon Sep 17 00:00:00 2001 From: Martin Ling Date: Sun, 28 Apr 2013 12:36:02 +0100 Subject: [PATCH] Document enumeration functions. --- serialport.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/serialport.c b/serialport.c index 43415a0..60a1a75 100644 --- a/serialport.c +++ b/serialport.c @@ -68,6 +68,11 @@ fail: 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 **list = NULL; @@ -197,6 +202,9 @@ out: #endif } +/** + * Free a port list returned by sp_list_ports. + */ void sp_free_port_list(char **list) { unsigned int i;