From: Uwe Hermann <redacted>
Date: Sun, 21 Oct 2012 23:21:20 +0000 (+0200)
Subject: Doxygen: libsigrok.h: Explain #include file usage.
X-Git-Tag: dsupstream~633
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=1f345a21d24e52f482a06da9e434f751abdff203;p=libsigrok.git

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

diff --git a/libsigrok.h b/libsigrok.h
index 481fe4fe..49d5aa81 100644
--- a/libsigrok.h
+++ b/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
  */
 
 /*