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

diff --git a/libsigrok.h b/libsigrok.h
index 481fe4fe3cf09c85c9f59d421cc85c6de46d49c3..49d5aa8135722f897e759f9daa7c45d857b6e7ae 100644 (file)
--- 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
  */
 
 /*