From e72274d1ea5a343fa19837ffc18a90a43fe4276f Mon Sep 17 00:00:00 2001
From: Thomas Bernard <miniupnp@free.fr>
Date: Thu, 26 Dec 2019 23:42:57 +0100
Subject: [PATCH] colorred.c/.h: doxygen

---
 src/colorred.c | 10 ++++++++--
 src/colorred.h | 24 +++++++++++++++---------
 2 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/src/colorred.c b/src/colorred.c
index 0d747ec2..bcab5848 100644
--- a/src/colorred.c
+++ b/src/colorred.c
@@ -47,6 +47,9 @@ void CT_Print(CT_Node* node)
 }
 */
 
+/**
+ * insert a node in the color tree
+ */
 void CT_set(CT_Tree* colorTree, byte Rmin, byte Gmin, byte Bmin,
 	byte Rmax, byte Gmax, byte Bmax, byte index)
 {
@@ -102,10 +105,13 @@ void CT_set(CT_Tree* colorTree, byte Rmin, byte Gmin, byte Bmin,
   ++colorTree->nodecount;
 }
 
+/**
+ * find the leaf that also contains (rgb)
+ *
+ * pre condition: node contains (rgb)
+ */
 byte CT_get(CT_Tree* tree, byte r, byte g, byte b)
 {	
-	// pre condition: node contains (rgb)
-	// find the leaf that also contains (rgb)
 	
 	CT_Node* node = &tree->nodes[0];
 	
diff --git a/src/colorred.h b/src/colorred.h
index b1927c1f..10761484 100644
--- a/src/colorred.h
+++ b/src/colorred.h
@@ -16,24 +16,27 @@
 
     You should have received a copy of the GNU General Public License
     along with Grafx2; if not, see <http://www.gnu.org/licenses/>
-
-********************************************************************************
-
-    24bit RGB to 8bit indexed functions
 */
 
 #include "struct.h"
 
-/* Octree for mapping RGB to color. A bit slower than a plain conversion table in theory,
+/**
+ * @file colorred.h
+ * 24bit RGB to 8bit indexed functions
+ *
+ * Octree for mapping RGB to color. A bit slower than a plain conversion table in theory,
 but :
-  * Faster than running a search in the palette
-  * Takes less memory than the huge conversion table
-  * No loss of precision
-*/
+ * Faster than running a search in the palette
+ * Takes less memory than the huge conversion table
+ * No loss of precision
+ */
 
 #ifndef __COLORRED_H
 #define __COLORRED_H
 
+/**
+ * Color Tree node
+ */
 typedef struct CT_Node_s
 {
 	// min
@@ -62,6 +65,9 @@ typedef struct CT_Node_s
 	word children[2];
 } CT_Node;
 
+/**
+ * Color Tree
+ */
 typedef struct ColorTree_S {
 	short nodecount;
 	CT_Node nodes[511];