Doxygen: Add @file items for the relevant files.

[libsigrokdecode.git] / sigrokdecode.h.in

diff --git a/sigrokdecode.h.in b/sigrokdecode.h.in
index 033e30ee4652e557097c2facd5f62998eebde4db..ca069c528a3403ac478354267e8ea6ae1cb32f74 100644 (file)
--- a/sigrokdecode.h.in
+++ b/sigrokdecode.h.in
@@ -30,6 +30,22 @@
 extern "C" {
 #endif
 
+/**
+ * @file
+ *
+ * The public libsigrokdecode header file to be used by frontends.
+ *
+ * This is the only file that libsigrokdecode users (frontends) are supposed
+ * to use and include. There are other header files which get installed with
+ * libsigrokdecode, but those are not meant to be used directly by frontends.
+ *
+ * The correct way to get/use the libsigrokdecode API functions is:
+ *
+ * @code{.c}
+ *   #include <sigrokdecode.h>
+ * @endcode
+ */
+
 /*
  * Package version macros (can be used for conditional compilation).
  */