Drop link-mso19/nexus-osciprime in preparation for release.

[libsigrok.git] / error.c

diff --git a/error.c b/error.c
index 761c94e4da3662fbb87e1f3dd3dd5720a3fa31d8..ce1b0401ddbad2a8dc2aeb54d4d62335ec2db31d 100644 (file)
--- 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,6 +20,12 @@
 
 #include "libsigrok.h"
 
+/**
+ * @file
+ *
+ * Error handling in libsigrok.
+ */
+
 /**
  * @defgroup grp_error Error handling
  *
@@ -35,10 +41,14 @@
  * 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)
 {
@@ -59,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;
@@ -83,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)
 {
@@ -106,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;