X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=sigrokdecode.h.in;h=ca069c528a3403ac478354267e8ea6ae1cb32f74;hp=6b05b64db622fc2f61ccba9b1bf5b7be3ac74c62;hb=54fdeeefffe31d32dddaf0f3d6a99dc7b3bc2448;hpb=42515b0f25613499167b66c1d8a659526fb46b8d

diff --git a/sigrokdecode.h.in b/sigrokdecode.h.in
index 6b05b64..ca069c5 100644
--- 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).
  */
@@ -99,7 +115,7 @@ extern "C" {
  * Use SRD_API to mark public API symbols, and SRD_PRIV for private symbols.
  *
  * Variables and functions marked 'static' are private already and don't
- * need SR_PRIV. However, functions which are not static (because they need
+ * need SRD_PRIV. However, functions which are not static (because they need
  * to be used in other libsigrokdecode-internal files) but are also not
  * meant to be part of the public libsigrokdecode API, must use SRD_PRIV.
  *