From c45eb4bee2533fc4ac65375c12ba8ed369f61379 Mon Sep 17 00:00:00 2001 From: Martin Ling Date: Sun, 3 Nov 2013 23:12:03 +0000 Subject: [PATCH] Update documentation. --- README | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README b/README index ae96bea..6e3b480 100644 --- a/README +++ b/README @@ -61,8 +61,9 @@ API The API is simple, and designed to be a minimal wrapper around the serial port support in each OS. -Most functions take a pointer to a struct sp_port, which represents an serial -port. This structure is obtained from the array returned by sp_list_ports(). +Most functions take a pointer to a struct sp_port, which represents a serial +port. These structures are always allocated and freed by the library, using the +functions in the 'Enumeration' section below. All functions can return only three possible error values. SP_ERR_ARG indicates the function was called with invalid arguments. SP_ERR_FAIL indicates that the