Changeset 4872:8bbe71569709 in roaraudio

Timestamp:

04/26/11 10:29:31 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

added some comments

File:

• include/libroar/error.h (modified) (1 diff)

include/libroar/error.h

@@ -73 +73 @@
 int *  roar_errno2(void);
 
+// clear RoarAudio's error value
 void   roar_err_clear(void);
+
+// clear system's error value (errno)
 void   roar_err_clear_errno(void);
+
+// clear all error values (to be used before calling roar_err_update())
 void   roar_err_clear_all(void);
+
+// syncs RoarAudio's and system's error values
 void   roar_err_update(void);
+
+// test of system's error value is set to 'no error'
 int    roar_err_is_errno_clean(void);
+
+// set RoarAudio's error value
 void   roar_err_set(const int error);
+
+// sync RoarAudio's error value with the value from the system
 void   roar_err_from_errno(void);
+
+// sync systen's error value with the value from RoarAudio
 void   roar_err_to_errno(void);
 
+// Return a string descriping the error
 const char * roar_error2str(const int error);