From 54fdeeefffe31d32dddaf0f3d6a99dc7b3bc2448 Mon Sep 17 00:00:00 2001 From: Uwe Hermann Date: Sat, 9 Feb 2013 22:10:57 +0100 Subject: Doxygen: Add @file items for the relevant files. These short descriptions are shown in the "Files" section of the Doxygen output. --- sigrokdecode.h.in | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'sigrokdecode.h.in') diff --git a/sigrokdecode.h.in b/sigrokdecode.h.in index 033e30e..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 + * @endcode + */ + /* * Package version macros (can be used for conditional compilation). */ -- cgit v1.2.3-70-g09d2