Add some comments and documentation

2 files changed, 12 insertions, 0 deletions

diff --git a/README.md b/README.md
index a4fea2f..eb807f9 100644
--- a/README.md
+++ b/README.md
@@ -84,6 +84,16 @@ Make sure CUnit is installed, then add ```-DBUILD_UNITTESTS=1``` to the cmake ar
 
 You can run unittests by running ```make unittest```.
 
+### 2.5. Building with AddressSanitizer
+
+This is for development/debugging use only!
+
+Make sure llvm is installed, then add ```-DUSE_ASAN=1``` to the cmake arguments and rebuild. Note that ASAN is not
+supported on all OSes (eg. windows).
+
+After building, you can run with the following (make sure to set correct llvm-symbolizer path):
+```ASAN_OPTIONS=symbolize=1 ASAN_SYMBOLIZER_PATH=/usr/bin/llvm-symbolizer ./examplevideo <my videofile>```
+
 ## 3. License
 
 MIT. Please see ```LICENSE``` for details.
diff --git a/src/internal/subtitle/kitatlas.c b/src/internal/subtitle/kitatlas.c
index a97dd1d..a011989 100644
--- a/src/internal/subtitle/kitatlas.c
+++ b/src/internal/subtitle/kitatlas.c
@@ -25,11 +25,13 @@ Kit_TextureAtlas* Kit_CreateAtlas(int w, int h) {
     atlas->w = w;

     atlas->h = h;

 

+    // Allocate items. These hold the surfaces that should be in atlas

     atlas->items = calloc(atlas->max_items, sizeof(Kit_TextureAtlasItem));

     if(atlas->items == NULL) {

         goto exit_1;

     }

 

+    // Allocate shelves. These describe the used space of the atlas

     atlas->shelves = calloc(atlas->max_shelves, sizeof(Kit_Shelf));

     if(atlas->shelves == NULL) {

         goto exit_2;