dev: clean docs and everything, add TODOs

source/mlx_inline.c

@@ -5,6 +5,14 @@
  *   at https://github.com/frzysk/mlx3ds
  */
 
+/**
+ * This file contains some internal functions that have to be inline for
+ * optimization purposes.
+ *
+ * Yes, I do include this file directly even if it's a .c file.
+ * What the norminette doesn't know can't hurt it.
+ */
+
 #include "3ds.h"
 
 /// @brief Write a color at a specific location of the memory,

source/mlx_int.h

@@ -8,12 +8,17 @@
 ** Last update Wed May 25 16:44:16 2011 Olivier Crouzet
 */
 
-
-
 /*
 ** Internal settings for MiniLibX
 */
 
+/**
+ * Modified by Zy to work with the MinilibX For 3DS project
+ * (at https://github.com/frzysk/mlx3ds).
+ */
+
+// TODO: from mlx xpm: clean
+
 #ifndef MLX_INT_H
 
 # define MLX_INT_H

source/mlx_int_str_to_wordtab.c

@@ -8,6 +8,13 @@
 ** Last update Fri Dec 14 11:02:09 2001 Charlie Root
 */
 
+/**
+ * Modified by Zy to work with the MinilibX For 3DS project
+ * (at https://github.com/frzysk/mlx3ds).
+ */
+
+// TODO: from mlx xpm: clean
+
 #include	"mlx_int.h"
 
 // [USED] [FULL]

source/mlx_internal.cpp

@@ -5,6 +5,8 @@
  *   at https://github.com/frzysk/mlx3ds
  */
 
+// TODO mlx_internal.cpp: embed uc_pause() and change to .c file
+
 #include "utilsconsole.hpp"
 
 extern "C" {

source/mlx_internal.h

@@ -6,7 +6,7 @@
  */
 
 /**
- * Internal utils of the mlx3ds.
+ * This file contains internal utils.
  */
 
 #ifndef MLX_INTERNAL_H

source/mlx_rgb.c

@@ -3,6 +3,13 @@
 ** the XFree86 distribution.
 */
 
+/**
+ * Modified by Zy to work with the MinilibX For 3DS project
+ * (at https://github.com/frzysk/mlx3ds).
+ */
+
+// TODO: from mlx xpm: clean
+
 #include	"mlx_int.h"
 
 struct s_col_name mlx_col_name[] =

source/mlx_xpm.c

@@ -8,6 +8,13 @@
  ** Last update Sat Oct  1 14:56:13 2005 Olivier Crouzet
  */
 
+/**
+ * Modified by Zy to work with the MinilibX For 3DS project
+ * (at https://github.com/frzysk/mlx3ds).
+ */
+
+// TODO: from mlx xpm: clean
+
 #include	"mlx_int.h"
 #include	"mlx.h"
 #include	"mlx_internal.h"