From 72df0de8cb579fd96449d19eb57fc71335907a19 Mon Sep 17 00:00:00 2001
From: Kimplul <kimi.h.kuparinen@gmail.com>
Date: Sun, 22 May 2022 23:35:02 +0300
Subject: add @file info to all files

+ Next step, start documenting contents of each file.
---
 common/sp_tree.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'common/sp_tree.c')

diff --git a/common/sp_tree.c b/common/sp_tree.c
index 5097757..9003f40 100644
--- a/common/sp_tree.c
+++ b/common/sp_tree.c
@@ -1,3 +1,13 @@
+/**
+ * @file sp_tree.c
+ * Implementation of my sp_trees. An sp_tree is a mix of rb-trees and avl-trees,
+ * with slightly faster insertion but worse tree depth on average.
+ *
+ * See https://github.com/Kimplul/sptree
+ *
+ * \todo Document sp_tree algorithm better.
+ */
+
 #include <apos/sp_tree.h>
 
 static void __sp_turn_left(struct sp_node *n)
-- 
cgit v1.3