mirror/libserialport
mirror/libserialport
1
0
Fork 0
mirror of git://sigrok.org/libserialport synced 2023-08-10 21:13:24 +03:00
Code Issues Projects Releases Wiki Activity
353 Commits 3 Branches 3 Tags 455 KiB
8488868187
Commit Graph

74 Commits

Author SHA1 Message Date
Uwe Hermann
44df415480 Doxygen: Fix an issue causing missing #define documentation output. 
Searching for documented defines...
  [...]libserialport.h:1624: warning: documentation for unknown define SP_PACKAGE_VERSION_MAJOR found.
  [...]libserialport.h:1627: warning: documentation for unknown define SP_PACKAGE_VERSION_MINOR found.
  [...]libserialport.h:1630: warning: documentation for unknown define SP_PACKAGE_VERSION_MICRO found.
  [...]libserialport.h:1633: warning: documentation for unknown define SP_PACKAGE_VERSION_STRING found.
  [...]libserialport.h:1640: warning: documentation for unknown define SP_LIB_VERSION_CURRENT found.
  [...]libserialport.h:1643: warning: documentation for unknown define SP_LIB_VERSION_REVISION found.
  [...]libserialport.h:1646: warning: documentation for unknown define SP_LIB_VERSION_AGE found.
  [...]libserialport.h:1649: warning: documentation for unknown define SP_LIB_VERSION_STRING found.
 2020-01-05 18:19:32 +01:00
Martin Ling
ad19d60493 Add some additional formatting hints to Doxygen comments. 2020-01-05 03:28:58 +00:00
Martin Ling
7c8d67efdc Integrate examples into Doxygen. 2020-01-05 03:04:38 +00:00
Daniel Elstner
f1c916ede1 Build: Clean up configure.ac and Makefile.am 
Among other things, rename some config defines so we can take
advantage of standard Autoconf macros.
 2015-08-26 21:55:10 +02:00
Martin Ling
f77bb46df5 Update copyright notices. 2015-05-31 18:26:53 +02:00
Martin Ling
56fe6e3207 doc: Provided channel is binary, not necessarily 8-bit. 2015-05-30 21:03:38 +01:00
Martin Ling
49fd7b1bc2 doc: Additional introductory text. 2015-05-30 21:38:03 +02:00
Martin Ling
deef6e528c doc: Expanded introductory text. 2015-05-27 11:19:27 +02:00
Martin Ling
ec4b55ae25 doc: Additional notes on sp_last_error_{code,message}. 2015-05-27 11:09:26 +02:00
Martin Ling
e5c2630eee Add new sp_blocking_read_next() function. 2015-05-27 11:09:26 +02:00
Martin Ling
480d750c59 doc: correct structure name in sp_get_port_handle() documentation. 2015-05-06 16:33:13 +01:00
Uwe Hermann
ff6da776e8 libserialport.h.in: Fix/update some API docs. 2015-05-06 17:06:06 +02:00
Uwe Hermann
9eb9f07130 sp_get_port_usb_vid_pid(): Document that usb_vid/usb_pid can be NULL. 2015-04-19 19:18:05 +02:00
Uwe Hermann
1b91c6eadb Rename timeout to timeout_ms for clarity in a few places. 2015-04-19 19:01:08 +02:00
Uwe Hermann
f14809393a Constify the sp_get_port_description() parameter. 2015-04-19 19:01:08 +02:00
Uwe Hermann
ad036cc8ef Constify the sp_get_port_transport() parameter. 2015-04-19 18:28:10 +02:00
Uwe Hermann
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
Uwe Hermann
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
Uwe Hermann
13efecf888 libserialport.h.in: Add @since tags for new enums. 2015-04-19 18:14:48 +02:00
Uwe Hermann
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
Uwe Hermann
144a598f19 Minor Doxygen improvements and fixes. 2015-04-07 01:32:40 +02:00
Uwe Hermann
cfa5af67fd Fix some typos. 2015-03-26 23:57:55 +01:00
Bert Vermeulen
d66bbceaa7 Fix typos. 2014-10-05 02:38:35 +02:00
Aurelien Jacobs
276ef1b92f Add SP_MODE_READ_WRITE enum value. 2014-09-20 21:24:31 +02:00
Antti Nykanen
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
Aurelien Jacobs
f3ccf157cb Rename sp_get_signals() parameter to avoid name clash with Qt headers. 2014-08-20 22:39:29 +02:00
Martin Ling
e33dcf90a0 Tidy up and split most OS-specific code to separate files. 2014-06-11 15:10:29 +01:00
Aurelien Jacobs
a93fb46888 Add new APIs to get some USB descriptor details for USB serial ports. 2014-06-10 23:51:11 +02:00
Uwe Hermann
1652aa869f Add Doxygen @since tags to all public API functions. 2014-05-05 02:09:11 +02:00
Uwe Hermann
524b0e1454 Add runtime version querying functions. 
This fixes bug #282.
 2014-03-13 12:23:56 +01:00
Uwe Hermann
deaf0a6351 Doxygen: Fix a warning / incorrect parameter name. 2013-12-27 02:39:29 +01:00
Martin Ling
6f1186aa82 Add API for waiting on port events. 2013-12-20 18:24:42 +00:00
Uwe Hermann
0a1ab8bf8f Minor Doxygen updates/fixes. 2013-12-17 22:39:19 +01:00
Martin Ling
2c827b2188 Handle EINTR from tcdrain() in sp_drain(). 2013-11-27 14:35:36 +00:00
Martin Ling
b87deb7c70 Clarify documentation regarding signals and EINTR. 2013-11-27 14:12:12 +00:00
Martin Ling
859874648e Fix error in documentation. 2013-11-27 14:12:04 +00:00
Martin Ling
2007ce5e14 Document EINTR handling. 2013-11-27 13:18:29 +00:00
Martin Ling
3353c22f32 Add sp_input_waiting() and sp_output_waiting() functions. 2013-11-27 02:55:18 +00:00
Martin Ling
e3dcf9068e New API and implementation for blocking and non-blocking I/O. 2013-11-27 01:45:48 +00:00
Martin Ling
e432ce6006 Support mark/space parity settings. 2013-11-25 18:05:58 +00:00
Martin Ling
9b1502efce Make configuration structure opaque. 2013-11-23 20:43:13 +00:00
Martin Ling
0151b15710 Clarify documentation. 2013-11-23 18:23:45 +00:00
Martin Ling
3c126654b3 Add sp_get_port_handle() function. 2013-11-23 17:50:45 +00:00
Martin Ling
1c5aae9dc5 Make port structure opaque. 2013-11-23 17:11:19 +00:00
Martin Ling
863b35e69c Add API for and default handler for debug messages. 2013-11-22 22:41:03 +00:00
Martin Ling
f36c639545 Remove dupliate/redundant return value documentation. 2013-11-22 21:58:51 +01:00
Martin Ling
6aabf62a90 Use new SP_ERR_SUPP error to indicate unsupported operations. 2013-11-22 21:46:26 +01:00
Uwe Hermann
7de20e3915 Use common 3-digit package version number. 2013-11-22 16:44:29 +01:00
Uwe Hermann
24abdb680f Minor cosmetics. 2013-11-22 16:10:55 +01:00
Uwe Hermann
8645feda60 Add missing #include guards. 2013-11-22 11:59:12 +01:00