ff6da776e8
libserialport.h.in: Fix/update some API docs.
2015-05-06 17:06:06 +02:00
9eb9f07130
sp_get_port_usb_vid_pid(): Document that usb_vid/usb_pid can be NULL.
2015-04-19 19:18:05 +02:00
1b91c6eadb
Rename timeout to timeout_ms for clarity in a few places.
2015-04-19 19:01:08 +02:00
f14809393a
Constify the sp_get_port_description() parameter.
2015-04-19 19:01:08 +02:00
ad036cc8ef
Constify the sp_get_port_transport() parameter.
2015-04-19 18:28:10 +02:00
35578b063e
Various Doxygen comment updates and fixes.
...
- Add some missing @param lines.
- Add [in], [out], or [in,out] markers for @param tags.
- Add explicit "Must not be NULL" comments for parameters where
the caller should not pass in a NULL.
2015-04-19 18:16:01 +02:00
e4f44cf5f2
libserialport.h.in: Drop unneeded <windows.h> #include.
...
This is not needed and would pollute the namespace of every
libserialport user on Windows.
2015-04-19 18:15:29 +02:00
13efecf888
libserialport.h.in: Add @since tags for new enums.
2015-04-19 18:14:48 +02:00
3f2f48fc01
Set package version to 0.1.1, use "@since 0.1.1" Doxygen tags.
...
The next release will not contain any backwards-incompatible
API or ABI changes, thus changing the package version to 0.1.1.
2015-04-19 18:13:53 +02:00
144a598f19
Minor Doxygen improvements and fixes.
2015-04-07 01:32:40 +02:00
cfa5af67fd
Fix some typos.
2015-03-26 23:57:55 +01:00
d66bbceaa7
Fix typos.
2014-10-05 02:38:35 +02:00
276ef1b92f
Add SP_MODE_READ_WRITE enum value.
2014-09-20 21:24:31 +02:00
79a8004637
libserialport.h.in: remove trailing commas in enum definitions
...
This makes it easier to use libserialport on projects that build with
the GCC -pedantic flag enabled.
2014-08-24 11:56:45 +01:00
f3ccf157cb
Rename sp_get_signals() parameter to avoid name clash with Qt headers.
2014-08-20 22:39:29 +02:00
e33dcf90a0
Tidy up and split most OS-specific code to separate files.
2014-06-11 15:10:29 +01:00
a93fb46888
Add new APIs to get some USB descriptor details for USB serial ports.
2014-06-10 23:51:11 +02:00
1652aa869f
Add Doxygen @since tags to all public API functions.
2014-05-05 02:09:11 +02:00
524b0e1454
Add runtime version querying functions.
...
This fixes bug #282 .
2014-03-13 12:23:56 +01:00
deaf0a6351
Doxygen: Fix a warning / incorrect parameter name.
2013-12-27 02:39:29 +01:00
6f1186aa82
Add API for waiting on port events.
2013-12-20 18:24:42 +00:00
0a1ab8bf8f
Minor Doxygen updates/fixes.
2013-12-17 22:39:19 +01:00
2c827b2188
Handle EINTR from tcdrain() in sp_drain().
2013-11-27 14:35:36 +00:00
b87deb7c70
Clarify documentation regarding signals and EINTR.
2013-11-27 14:12:12 +00:00
859874648e
Fix error in documentation.
2013-11-27 14:12:04 +00:00
2007ce5e14
Document EINTR handling.
2013-11-27 13:18:29 +00:00
3353c22f32
Add sp_input_waiting() and sp_output_waiting() functions.
2013-11-27 02:55:18 +00:00
e3dcf9068e
New API and implementation for blocking and non-blocking I/O.
2013-11-27 01:45:48 +00:00
e432ce6006
Support mark/space parity settings.
2013-11-25 18:05:58 +00:00
9b1502efce
Make configuration structure opaque.
2013-11-23 20:43:13 +00:00
0151b15710
Clarify documentation.
2013-11-23 18:23:45 +00:00
3c126654b3
Add sp_get_port_handle() function.
2013-11-23 17:50:45 +00:00
1c5aae9dc5
Make port structure opaque.
2013-11-23 17:11:19 +00:00
863b35e69c
Add API for and default handler for debug messages.
2013-11-22 22:41:03 +00:00
f36c639545
Remove dupliate/redundant return value documentation.
2013-11-22 21:58:51 +01:00
6aabf62a90
Use new SP_ERR_SUPP error to indicate unsupported operations.
2013-11-22 21:46:26 +01:00
7de20e3915
Use common 3-digit package version number.
2013-11-22 16:44:29 +01:00
24abdb680f
Minor cosmetics.
2013-11-22 16:10:55 +01:00
8645feda60
Add missing #include guards.
2013-11-22 11:59:12 +01:00
3f099f4fe8
Add missing @param port entries to documentation.
2013-11-22 02:11:45 +01:00
8cf7c6978f
Add sp_get_signals() function.
2013-11-22 02:11:40 +01:00
90cc3ee62b
Add sp_start_break() and sp_end_break() functions.
2013-11-22 02:11:34 +01:00
69a3739ca0
Add sp_drain() function.
2013-11-22 02:11:34 +01:00
ea34fba899
Add missing @param port entry to documentation.
2013-11-22 01:53:27 +01:00
fd8fd11a4e
Make sp_flush take an option for what to flush.
2013-11-22 01:53:22 +01:00
a036341bdf
Use a more logical set of SP_MODE_* flags.
2013-11-22 01:48:02 +01:00
20e63a77b5
Define SP_PARITY_* more logically.
2013-11-22 01:47:34 +01:00
cf9d365ce0
Doxygen cosmetics.
2013-11-19 20:10:56 +01:00
626d280fd3
Consistently use the "@" notation for Doxygen tags.
2013-11-19 19:37:03 +01:00
c85d0a28de
Fix minor Doxygen warning.
2013-11-19 12:30:55 +01:00
Uwe Hermann