Add initial README.devices file.

[libsigrok.git] / error.c

diff --git a/error.c b/error.c
index 1e33d9ab467bc76663362f2b3081133ef4217e3c..c9b8589e218991059c3dcc4cd4eeeb6fb4f340e7 100644 (file)
--- a/error.c
+++ b/error.c
@@ -20,11 +20,20 @@
 
 #include "libsigrok.h"
 
+/**
+ * @file
+ *
+ * Error handling in libsigrok.
+ */
+
 /**
  * @defgroup grp_error Error handling
  *
  * Error handling in libsigrok.
  *
+ * libsigrok functions usually return @ref SR_OK upon success, or a negative
+ * error code on failure.
+ *
  * @{
  */