From 778d324d6b4f60f310011050c397849340586462 Mon Sep 17 00:00:00 2001
From: Florian Burgener <florian.brgnr@gmail.com>
Date: Sat, 11 Jun 2022 00:38:16 +0200
Subject: [PATCH] Documentation

---
 src/BPTree.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/BPTree.c b/src/BPTree.c
index 42fc33a..9c56ea2 100644
--- a/src/BPTree.c
+++ b/src/BPTree.c
@@ -110,6 +110,13 @@ bool BPTree_search(BPTreeNode *root, uint64_t key, uint64_t *data) {
 
 // "traverse" function for insertion and deletion.
 
+/**
+ * @brief Finds the next node from a node with respect to a given key.
+ *
+ * @param node The origin node.
+ * @param key The key that must be compared.
+ * @return BPTreeNode* The next node.
+ */
 static BPTreeNode *traverse(BPTreeNode *node, uint64_t key) {
     int virtual_insertion_index = IntegerArray_lower_bound(node->keys, key);
 
-- 
GitLab