Doxygen: libsigrok.h: Explain #include file usage.
This commit is contained in:
parent
a02d77bce9
commit
1f345a21d2
10
libsigrok.h
10
libsigrok.h
|
@ -34,6 +34,16 @@ extern "C" {
|
|||
* @file
|
||||
*
|
||||
* The public libsigrok header file to be used by frontends.
|
||||
*
|
||||
* This is the only file that libsigrok users (frontends) are supposed to
|
||||
* use and #include. There are other header files which get installed with
|
||||
* libsigrok, but those are not meant to be used directly by frontends.
|
||||
*
|
||||
* The correct way to get/use the libsigrok API functions is:
|
||||
*
|
||||
* @code{.c}
|
||||
* #include <libsigrok/libsigrok.h>
|
||||
* @endcode
|
||||
*/
|
||||
|
||||
/*
|
||||
|
|
Loading…
Reference in New Issue