extended documentation

2015-11-15 14:42:58 +01:00
parent af0ce31ecb
commit ac5f4f25b1
4 changed files with 100 additions and 12 deletions
@@ -19,7 +19,13 @@
 #ifndef LIBEBUS_RESULT_H_
 #define LIBEBUS_RESULT_H_

-/** \file result.h */
+/** @file result.h
+ * Functions, and constants related to execution results.
+ *
+ * The #result_t codes defined here are used by many functions to emit the
+ * result of the function call. Zero and positive values indicate success,
+ * whereas negative values indicate failure.
+ */

 /** type for result code. */
 enum result_t {