X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;ds=inline;f=error.c;h=ce1b0401ddbad2a8dc2aeb54d4d62335ec2db31d;hb=50985c2019b2b5a6ce394589d89ee925b4f5e3a9;hp=d0697bc84e84fda1f9e4046ab317176bbd1d4c88;hpb=b5a8e848256f54b32ca988be5a1ec2db5048873a;p=libsigrok.git

diff --git a/error.c b/error.c
index d0697bc8..ce1b0401 100644
--- a/error.c
+++ b/error.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
  *
@@ -20,14 +20,35 @@
 
 #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.
+ *
+ * @{
+ */
+
 /**
  * Return a human-readable error string for the given libsigrok error code.
  *
  * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
+ *
  * @return A const string containing a short, human-readable (English)
  *         description of the error, such as "memory allocation error".
  *         The string must NOT be free'd by the caller!
+ *
  * @see sr_strerror_name
+ *
+ * @since 0.2.0
  */
 SR_API const char *sr_strerror(int error_code)
 {
@@ -48,12 +69,18 @@ SR_API const char *sr_strerror(int error_code)
 	case SR_ERR_MALLOC:
 		str = "memory allocation error";
 		break;
+	case SR_ERR_ARG:
+		str = "invalid argument";
+		break;
 	case SR_ERR_BUG:
 		str = "internal error";
 		break;
 	case SR_ERR_SAMPLERATE:
 		str = "invalid samplerate";
 		break;
+	case SR_ERR_NA:
+		str = "not applicable";
+		break;
 	default:
 		str = "unknown error";
 		break;
@@ -72,9 +99,13 @@ SR_API const char *sr_strerror(int error_code)
  * a libsigrok error code is useful.
  *
  * @param error_code A libsigrok error code number, such as SR_ERR_MALLOC.
+ *
  * @return A const string containing the "name" of the error code as string.
  *         The string must NOT be free'd by the caller!
+ *
  * @see sr_strerror
+ *
+ * @since 0.2.0
  */
 SR_API const char *sr_strerror_name(int error_code)
 {
@@ -95,12 +126,18 @@ SR_API const char *sr_strerror_name(int error_code)
 	case SR_ERR_MALLOC:
 		str = "SR_ERR_MALLOC";
 		break;
+	case SR_ERR_ARG:
+		str = "SR_ERR_ARG";
+		break;
 	case SR_ERR_BUG:
 		str = "SR_ERR_BUG";
 		break;
 	case SR_ERR_SAMPLERATE:
 		str = "SR_ERR_SAMPLERATE";
 		break;
+	case SR_ERR_NA:
+		str = "SR_ERR_NA";
+		break;
 	default:
 		str = "unknown error code";
 		break;
@@ -108,3 +145,5 @@ SR_API const char *sr_strerror_name(int error_code)
 
 	return str;
 }
+
+/** @} */