]> sigrok.org Git - libserialport.git/commitdiff
Document enumeration functions.
authorMartin Ling <redacted>
Sun, 28 Apr 2013 11:36:02 +0000 (12:36 +0100)
committerUwe Hermann <redacted>
Thu, 14 Nov 2013 23:42:36 +0000 (00:42 +0100)
serialport.c

index 43415a024b072901f10a0765a9ed452a90fc4d94..60a1a751ee096304bc4068babbe87db9816d0da3 100644 (file)
@@ -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;