Adding a new error code and commenting the existing ones :)

1 files changed, 6 insertions, 5 deletions

diff --git a/include/dtree/dtree.h b/include/dtree/dtree.h
index e9acf1a..988b8b4 100644
--- a/include/dtree/dtree.h
+++ b/include/dtree/dtree.h
@@ -63,11 +63,12 @@ typedef enum dt_err {
     FAILURE = -1,
     SUCCESS = 0,
 
-    INVALID_PARAMS,
-    MALLOC_FAILED,
-    INVALID_PAYLOAD,
-    DATA_NOT_RELATED,
-    NODE_NOT_FOUND,
+    INVALID_PARAMS,         // A function didn't get the required parameters
+    MALLOC_FAILED,          // A memory allocation failed
+    INVALID_PAYLOAD,        // The payload of a node is invalid
+    DATA_NOT_RELATED,       // Tried to split non-related trees
+    NODE_NOT_FOUND,         // The sought after node was not found
+    NODE_NOT_ORIGINAL,      // Tried to free a node which was a shallow copy
 
 } dt_err;