mirrors
/
libserialport
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: correct structure name in sp_get_port_handle() documentation.

This commit is contained in:
Martin Ling 2015-04-23 22:23:14 +01:00
parent ff6da776e8
commit 480d750c59
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libserialport.h.in
View File

@ -555,10 +555,10 @@ enum sp_return sp_get_port_handle(const struct sp_port *port, void *result_ptr);
/**
* Allocate a port configuration structure.
*
* The user should allocate a variable of type "struct sp_config *" and pass a
* pointer to this to receive the result. The variable will be updated to
* point to the new configuration structure. The structure is opaque and must
* be accessed via the functions provided.
* The user should allocate a variable of type "struct sp_port_config *" and
* pass a pointer to this to receive the result. The variable will be updated
* to point to the new configuration structure. The structure is opaque and
* must be accessed via the functions provided.
*
* All parameters in the structure will be initialised to special values which
* are ignored by sp_set_config().