From: Martin Ling <redacted>
Date: Sun, 28 Apr 2013 11:36:02 +0000 (+0100)
Subject: Document enumeration functions.
X-Git-Tag: libserialport-0.1.0~164
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=68ab64ccdcb6c0a845dce417c18a74fcf284f9d2;p=libserialport.git

Document enumeration functions.
---

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;