Doxygen: Add @file items for the relevant files.

[libsigrok.git] / backend.c

diff --git a/backend.c b/backend.c
index ae9dc49e898f87de99a23453c86c90c827dc3db8..9f0f119fa5bfc3b29cf37b4d1c7eeeb9e3f472fe 100644 (file)
--- a/backend.c
+++ b/backend.c
@@ -22,6 +22,61 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/**
+ * @mainpage libsigrok API
+ *
+ * @section sec_intro Introduction
+ *
+ * The <a href="http://sigrok.org">sigrok</a> project aims at creating a
+ * portable, cross-platform, Free/Libre/Open-Source signal analysis software
+ * suite that supports various device types (such as logic analyzers,
+ * oscilloscopes, multimeters, and more).
+ *
+ * <a href="http://sigrok.org/wiki/Libsigrok">libsigrok</a> is a shared
+ * library written in C which provides the basic API for talking to
+ * <a href="http://sigrok.org/wiki/Supported_hardware">supported hardware</a>
+ * and reading/writing the acquired data into various
+ * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
+ * file formats</a>.
+ *
+ * @section sec_api API reference
+ *
+ * See the "Modules" page for an introduction to various libsigrok
+ * related topics and the detailed API documentation of the respective
+ * functions.
+ *
+ * You can also browse the API documentation by file, or review all
+ * data structures.
+ *
+ * @section sec_mailinglists Mailing lists
+ *
+ * There are two mailing lists for sigrok/libsigrok: <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-devel">sigrok-devel</a> and <a href="https://lists.sourceforge.net/lists/listinfo/sigrok-commits">sigrok-commits</a>.
+ *
+ * @section sec_irc IRC
+ *
+ * You can find the sigrok developers in the
+ * <a href="irc://chat.freenode.net/sigrok">\#sigrok</a>
+ * IRC channel on Freenode.
+ *
+ * @section sec_website Website
+ *
+ * <a href="http://sigrok.org/wiki/Libsigrok">sigrok.org/wiki/Libsigrok</a>
+ */
+
+/**
+ * @file
+ *
+ * Initializing and shutting down libsigrok.
+ */
+
+/**
+ * @defgroup grp_init Initialization
+ *
+ * Initializing and shutting down libsigrok.
+ *
+ * @{
+ */
+
 /**
  * Initialize libsigrok.
  *
@@ -93,3 +148,5 @@ SR_API int sr_exit(struct sr_context *ctx)
 
        return SR_OK;
 }
+
+/** @} */