Add header comments to files in src

Fixes #9

Author: sfe-SparkFro

src/alloc.c

@@ -1,3 +1,17 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * alloc.c
+ * 
+ * Wrapper functions for malloc(), free(), calloc(), and realloc(). These ensure
+ * memory gets allocated on the C heap before the MicroPython garbage collector
+ * has been initialized, and and in the GC pool afterwards.
+ *------------------------------------------------------------------------------
+ */
+
 // C headers
 #include "py/runtime.h"
 

src/convert.cpp

@@ -1,3 +1,16 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * convert.cpp
+ * 
+ * Helper functions to convert between various data types from MicroPython, ulab
+ * NumPy, and OpenCV
+ *------------------------------------------------------------------------------
+ */
+
 // C++ headers
 #include "convert.h"
 #include "numpy.h"

src/convert.h

@@ -1,3 +1,16 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * convert.h
+ * 
+ * Helper functions to convert between various data types from MicroPython, ulab
+ * NumPy, and OpenCV.
+ *------------------------------------------------------------------------------
+ */
+
 // C++ headers
 #include "opencv2/core.hpp"
 

src/core.cpp

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * core.cpp
+ * 
+ * MicroPython wrappers for functions from the OpenCV core module.
+ *------------------------------------------------------------------------------
+ */
+
 // C++ headers
 #include "opencv2/core.hpp"
 #include "opencv2/imgcodecs.hpp"

src/core.h

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * core.h
+ * 
+ * MicroPython wrappers for functions from the OpenCV core module.
+ *------------------------------------------------------------------------------
+ */
+
 // C headers
 #include "py/runtime.h"
 

src/highgui.cpp

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * highgui.cpp
+ * 
+ * MicroPython wrappers for functions from the OpenCV highgui module.
+ *------------------------------------------------------------------------------
+ */
+
 // C++ headers
 #include "opencv2/core.hpp"
 #include "convert.h"

src/highgui.h

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * highgui.h
+ * 
+ * MicroPython wrappers for functions from the OpenCV highgui module.
+ *------------------------------------------------------------------------------
+ */
+
 // C headers
 #include "py/runtime.h"
 

src/imgcodecs.cpp

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * imgcodecs.cpp
+ * 
+ * MicroPython wrappers for functions from the OpenCV imgcodecs module.
+ *------------------------------------------------------------------------------
+ */
+
 // C++ headers
 #include "opencv2/core.hpp"
 #include "opencv2/imgcodecs.hpp"

src/imgcodecs.h

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * imgcodecs.h
+ * 
+ * MicroPython wrappers for functions from the OpenCV imgcodecs module.
+ *------------------------------------------------------------------------------
+ */
+
 // C headers
 #include "py/runtime.h"
 

src/imgproc.cpp

@@ -1,3 +1,15 @@
+/*
+ *------------------------------------------------------------------------------
+ * SPDX-License-Identifier: MIT
+ * 
+ * Copyright (c) 2025 SparkFun Electronics
+ *------------------------------------------------------------------------------
+ * imgproc.cpp
+ * 
+ * MicroPython wrappers for functions from the OpenCV imgproc module.
+ *------------------------------------------------------------------------------
+ */
+
 // C++ headers
 #include "opencv2/core.hpp"
 #include "opencv2/imgproc.hpp"