feat: comments defining the purpose of the files in the header

.gitignore

@@ -17,3 +17,4 @@
 *.wx64fsl
 *.wx32fsl
 
+*.mdx

core.lisp

@@ -1,5 +1,9 @@
 (in-package :monastery)
 
+;;; Main interface to the C ABI
+;;; All functions are raw defined here with its
+;;; types. See types.lisp for more information.
+
 (defcfun ("mdict_init" %mdict_init) :pointer
   (dictionary_path :string))
 

types.lisp

@@ -1,5 +1,10 @@
 (in-package :monastery)
 
+;;; The types here will be used in the Core.lisp
+;;; to define the return types and types used in the functions
+;;; hence why it is separated, more organization and in case
+;;; the ABI changes, it won't break everything
+
 (defcstruct sized-data
     (data :pointer)
   (size :size-t))
@@ -9,6 +14,7 @@
   (:mdict-encoding-hex 1))
 
 
+; naming type definition to make the references less verbose
 (defctype s-data '(:struct sized-data))
 (defctype mdict-encoding mdict-encoding-t)
 (defctype simple-key-item :pointer)