From: Uwe Hermann <redacted>
Date: Fri, 19 Oct 2012 08:06:45 +0000 (+0200)
Subject: Doxygen: Add initial main page documentation section.
X-Git-Tag: dsupstream~643
X-Git-Url: http://sigrok.org/gitweb/?a=commitdiff_plain;h=5b30cca719b737fed96c00e1b7a5094770d9d815;hp=d5f1d5382d2b2cb8999fefaf4e6e7af8067d110f;p=libsigrok.git

Doxygen: Add initial main page documentation section.
---

diff --git a/backend.c b/backend.c
index ae9dc49e..2d0b38e2 100644
--- a/backend.c
+++ b/backend.c
@@ -22,6 +22,43 @@
 #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_error_handling Error handling
+ *
+ * libsigrok functions usually return @ref SR_OK upon success, or a negative
+ * error code on failure.
+ *
+ * @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>
+ */
+
 /**
  * Initialize libsigrok.
  *