BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doxygen: libsigrok.h: Explain #include file usage.

This commit is contained in:
Uwe Hermann 2012-10-22 01:21:20 +02:00
parent a02d77bce9
commit 1f345a21d2
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
libsigrok.h
View File

@ -34,6 +34,16 @@ extern "C" {
* @file * @file
* *
* The public libsigrok header file to be used by frontends. * 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
*/ */
/* /*