From: Uwe Hermann <redacted>
Date: Sun, 21 Oct 2012 14:36:23 +0000 (+0200)
Subject: Doxygen: Move error handling stuff to error.c.
X-Git-Tag: dsupstream~640
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=f21193fa03c7fe1ff6708e22d7aeb318b5539191;p=libsigrok.git

Doxygen: Move error handling stuff to error.c.

Also, add an overview mini-section to the main page instead.
---

diff --git a/backend.c b/backend.c
index 840b1723..b3e38393 100644
--- a/backend.c
+++ b/backend.c
@@ -39,10 +39,14 @@
  * <a href="http://sigrok.org/wiki/Input_output_formats">input/output
  * file formats</a>.
  *
- * @section sec_error_handling Error handling
+ * @section sec_api API reference
  *
- * libsigrok functions usually return @ref SR_OK upon success, or a negative
- * error code on failure.
+ * 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
  *
diff --git a/error.c b/error.c
index 1e33d9ab..761c94e4 100644
--- a/error.c
+++ b/error.c
@@ -25,6 +25,9 @@
  *
  * Error handling in libsigrok.
  *
+ * libsigrok functions usually return @ref SR_OK upon success, or a negative
+ * error code on failure.
+ *
  * @{
  */