Added missing header comments.

src/display/animation/queue.c

@@ -83,7 +83,6 @@ void queueRestack(queue_t *queue) {
   }
 }
 
-
 void _queueDelayUpdate(queue_t *queue, queueaction_t *action, uint8_t i) {
   float n = queue->timeline - queue->actionStarted;
   if(n < queue->delays[i]) return;

src/display/gui/bitmapfont.c

@@ -7,12 +7,16 @@
 
 #include "bitmapfont.h"
 
-tilesetdiv_t * bitmapFontGetCharacterDivision(tileset_t *tileset, char character) {
+tilesetdiv_t * bitmapFontGetCharacterDivision(tileset_t *tileset,
+  char character
+) {
   int32_t i = ((int32_t)character) - BITMAP_FONT_CHAR_START;
   return tileset->divisions + i;
 }
 
-bitmapfontmeasure_t bitmapFontMeasure(char *string, float charWidth, float charHeight) {
+bitmapfontmeasure_t bitmapFontMeasure(char *string,
+  float charWidth, float charHeight
+) {
   int32_t i;
   float x, y;
   char c;

src/display/gui/bitmapfont.h

@@ -16,7 +16,9 @@
  * @param character Character to get the division for.
  * @return The division from the tileset for the character.
  */
-tilesetdiv_t * bitmapFontGetCharacterDivision(tileset_t *tileset, char character);
+tilesetdiv_t * bitmapFontGetCharacterDivision(tileset_t *tileset,
+  char character
+);
 
 /**
  * Measures a string's fully rendered size.
@@ -26,7 +28,9 @@ tilesetdiv_t * bitmapFontGetCharacterDivision(tileset_t *tileset, char character
  * @param charHeight The height of each character.
  * @return The measured string.
  */
-bitmapfontmeasure_t bitmapFontMeasure(char *string, float charWidth, float charHeight);
+bitmapfontmeasure_t bitmapFontMeasure(char *string,
+  float charWidth, float charHeight
+);
 
 /**
  * Renders a set of font characters to the sprite. Coordinates are anchored to
@@ -42,6 +46,7 @@ bitmapfontmeasure_t bitmapFontMeasure(char *string, float charWidth, float charH
  * @param charHeight Height of each character. Set to -1 to be the width ratio.
  * @returns The string measurement.
  */
-bitmapfontmeasure_t bitmapFontSpriteBatchBuffer(spritebatch_t *batch, tileset_t *tileset,
+bitmapfontmeasure_t bitmapFontSpriteBatchBuffer(
+  spritebatch_t *batch, tileset_t *tileset,
   char *string, float x, float y, float z, float charWidth, float charHeight
 );

src/display/primitive.c

@@ -7,7 +7,9 @@
 
 #include "primitive.h"
 
-void primitiveInit(primitive_t *primitive, int32_t verticeCount, int32_t indiceCount) {
+void primitiveInit(primitive_t *primitive,
+  int32_t verticeCount, int32_t indiceCount
+) {
   primitive->verticeCount = verticeCount;
   primitive->indiceCount = indiceCount;
 

src/display/primitive.h

@@ -14,7 +14,9 @@
  * @param verticeCount How many vertices can the primitive hold.
  * @param indiceCount How many indices can the primitive hold.
  */
-void primitiveInit(primitive_t *primitive, int32_t verticeCount, int32_t indiceCount);
+void primitiveInit(primitive_t *primitive,
+  int32_t verticeCount, int32_t indiceCount
+);
 
 /**
  * Buffer Vertices to a primitive for use in rendering.

src/display/render.c

@@ -28,6 +28,7 @@ void renderFrameStart(render_t *render) {
 }
 
 void renderDispose() {
+  
 }
 
 void renderSetResolution(render_t *render, float width, float height) {

src/display/shader.h

@@ -53,7 +53,7 @@ void shaderUseTexture(shader_t *shader, texture_t *texture);
  * @param uniform Uniform on the shader to set.
  * @param matrix Matrix to apply.
  */
-void shaderUseMatrix(shader_t *shader, shaderuniform_t uniform,matrix_t *matrix);
+void shaderUseMatrix(shader_t *shader,shaderuniform_t uniform,matrix_t *matrix);
 
 /**
  * Set's the current translation matrix onto the shader for the next

src/engine/engine.h

@@ -18,7 +18,7 @@
  * @param engine Engine to initialize.
  * @param game Game that intiialized this engine.
  */
-void engineInit(engine_t *engine, game_t *game);// TODO: This needs to return valid state.
+void engineInit(engine_t *engine, game_t *game);
 
 /**
  * Updates the given engine at the start of a frame.

src/epoch/epoch.c

@@ -14,10 +14,7 @@ void epochInit(epoch_t *epoch) {
 }
 
 void epochUpdate(epoch_t *epoch, float platformDelta) {
-  platformDelta = mathMax(
-    mathMin(platformDelta, EPOCH_FIXED_STEP),
-    0
-  );
+  platformDelta = mathClamp(platformDelta, 0, EPOCH_FIXED_STEP);
 
   epoch->last = epoch->current;
   epoch->current = epoch->current + platformDelta;

src/file/csv.c

@@ -208,6 +208,7 @@ bool _csvRowSearchCallback(
   data->rowIndex = row;
   return false;
 }
+
 int32_t csvRowSearch(
   assetbuffer_t *asset, csvrow_t *row, int32_t column, char *value
 ) {

src/file/csv.h

@@ -67,7 +67,6 @@ csvbufferresult_t csvBufferRowWithHeaders(
  */
 void csvRowPopulate(csvrow_t *source, csvrow_t *dest);
 
-
 /** Callback used to parse and get the headers row */
 bool _csvHeadersGetCallback(
   assetbuffer_t *asset, void *user, int32_t row, csvrow_t *current
@@ -82,7 +81,6 @@ bool _csvHeadersGetCallback(
  */
 csvbufferresult_t csvHeadersGet(assetbuffer_t *asset, csvrow_t *row);
 
-
 /**
  * Gets the column index within the CSV Row for the specific key.
  * @param row Row to get from.
@@ -95,6 +93,7 @@ int32_t csvColumnGetIndex(csvrow_t *row, char *key);
 bool _csvRowSearchCallback(
   assetbuffer_t *asset, void *user, int32_t row, csvrow_t *csv
 );
+
 /**
  * Search the CSV for a matching row. Will return data only if the given column
  * matches the given value.

src/game/dawn/dawngame.h

@@ -8,8 +8,24 @@
 #pragma once
 #include <dawn/dawn.h>
 
+/**
+ * Initializes the Dawn Game instance.
+ * 
+ * @param game Game to instanciate.
+ * @return True if successful otherwise false.
+ */
 bool dawnGameInit(game_t *game);
 
+/**
+ * Update the Dawn Game Instance.
+ * 
+ * @param game Game to update.
+ */
 void dawnGameUpdate(game_t *game);
 
+/**
+ * Cleanup the dawn game instance.
+ * 
+ * @param game Game to dispose.
+ */
 void dawnGameDispose(game_t *game);

src/game/poker/actions/action.h

@@ -7,7 +7,6 @@
 
 #pragma once
 #include <dawn/dawn.h>
-#include "../../../vn/conversation/talk.h"
 #include "../../../display/animation/queue.h"
 
 /**

src/game/poker/actions/bet.c

@@ -10,12 +10,14 @@
 void _pokerGameActionBetOnUpdate(
   queue_t *queue, queueaction_t *action, uint8_t i
 ) {
+  // Restack
   bool isHuman;
   bool turnMade = false;
   pokerturn_t turn;
   pokergame_t *game = (pokergame_t *)action->data;
   pokerplayer_t *player;
 
+  
   // Are they human?
   player = game->poker.players + game->poker.bet.better;
   isHuman = game->poker.bet.better == POKER_PLAYER_HUMAN_INDEX;

src/game/poker/actions/bet.h

@@ -12,4 +12,20 @@
 #include "../../../poker/bet.h"
 #include "../../../poker/actions/flop.h"
 
+/** Callback when the bet action is updated. */
+void _pokerGameActionBetOnUpdate(
+  queue_t *queue, queueaction_t *action, uint8_t i
+);
+
+/** Callback for when the bet action ends. */
+void _pokerGameActionBetOnEnd(
+  queue_t *queue, queueaction_t *action, uint8_t i
+);
+
+/**
+ * Queues the bet action to the queue.
+ * 
+ * @param game Game to queue onto.
+ * @return The action that was queued.
+ */
 queueaction_t * pokerGameActionBetAdd(pokergame_t *game);

src/game/poker/actions/look.c

@@ -7,7 +7,6 @@
 
 #include "look.h"
 
-
 void _pokerGameActionLookOnStart(
   queue_t *queue, queueaction_t *action, uint8_t i
 ) { 

src/game/poker/actions/look.h

@@ -11,6 +11,7 @@
 #include "../../../display/animation/queue.h"
 #include "../pokerworld.h"
 
+/** Callback when the look action starts. */
 void _pokerGameActionLookOnStart(
   queue_t *queue, queueaction_t *action, uint8_t i
 );

src/game/poker/actions/restack.c

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) 2021 Dominic Masters
+ * 
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+#include "restack.h"
+
+void _pokerGameActionRestackOnStart(
+  queue_t *queue, queueaction_t *action, uint8_t i
+) {
+  pokerGameQueueRestack(game);
+  queueNext(queue);
+}
+
+queueaction_t * pokerGameActionRestackAdd(pokergame_t *game) {
+  queueaction_t *action = pokerGameActionAdd(game);
+  action->onStart = &_pokerGameActionRestackOnStart;
+  return action;
+}

src/game/poker/actions/restack.h

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2021 Dominic Masters
+ * 
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+#pragma once
+#include <dawn/dawn.h>
+#include "action.h"
+#include "../pokergame.h"
+#include "../../../poker/turn.h"
+#include "../../../poker/bet.h"
+#include "../../../poker/actions/flop.h"
+
+/** Callback for when the queue restack action stars. */
+void _pokerGameActionRestackOnStart(
+  queue_t *queue, queueaction_t *action, uint8_t i
+);
+
+/**
+ * Adds a restack action to the queue.
+ * 
+ * @param game Game to restack.
+ * @return The queued action.
+ */
+queueaction_t * pokerGameActionRestackAdd(pokergame_t *game);

src/game/poker/actions/round.h

@@ -13,10 +13,12 @@
 #include "../discussion/pokerdiscussion.h"
 #include "bet.h"
 
+/** Callback that is fired when the round start event starts. */
 void _pokerGameActionRoundOnStart(
   queue_t *queue, queueaction_t *action, uint8_t i
 );
 
+/** Callback that is fired when the round action ends. */
 void _pokerGameActionRoundOnEnd(queue_t *queue,queueaction_t *action,uint8_t i);
 
 /**

src/game/poker/actions/start.h

@@ -14,10 +14,12 @@
 #include "action.h"
 #include "round.h"
 
+/** Callback fired when the game action first starts */
 void _pokerGameActionStartOnStart(
   queue_t *queue, queueaction_t *action, uint8_t i
 );
 
+/** Callback fired when the game start action ends */
 void _pokerGameActionStartOnEnd(queue_t *queue,queueaction_t *action,uint8_t i);
 
 /**

src/game/poker/discussion/pokerdiscussion.h

@@ -11,8 +11,16 @@
 #include "../../../vn/conversation/talk.h"
 #include "../actions/look.h"
 
-void pokerDiscussionGet(
-  pokerdiscussion_t *discussion, pokerdiscussiondata_t *data
-);
+/**
+ * Retreives the discussion based on some discussion data.
+ * @param disc The discussion data to buffer into.
+ * @param data The discussion data.
+ */
+void pokerDiscussionGet(pokerdiscussion_t *disc, pokerdiscussiondata_t *data);
 
+/**
+ * Queue a discussion data result onto the conversation stack.
+ * 
+ * @param data The discussion data.
+ */
 void pokerDiscussionQueue(pokerdiscussiondata_t *data);

src/game/poker/pokergame.c

@@ -68,4 +68,15 @@ void pokerGameDispose(game_t *game) {
 
   // Unload all assets
   pokerGameAssetsDispose(&pokerGame->assets);
+}
+
+void pokerGameQueueRestack(pokergame_t *pokerGame) {
+  arrayRewind(
+    sizeof(pokergameactiondata_t),
+    pokerGame->actionData,
+    ANIMATION_QUEUE_ITEM_MAX,
+    pokerGame->scene.conversation.actionQueue.current,
+    pokerGame->scene.conversation.actionQueue.count
+  );
+  queueRestack(&pokerGame->scene.conversation.actionQueue);
 }

src/game/poker/pokergame.h

@@ -11,6 +11,7 @@
 #include "../../poker/poker.h"
 #include "../../vn/conversation/talk.h"
 #include "../../vn/vnscene.h"
+#include "../../util/array.h"
 #include "actions/start.h"
 #include "pokerui.h"
 #include "pokerworld.h"
@@ -34,4 +35,11 @@ void pokerGameUpdate(game_t *game);
  * Disposes a previously initialized poker game instance.
  * @param game Game to initialize for.
  */
-void pokerGameDispose(game_t *game);
+void pokerGameDispose(game_t *game);
+
+/**
+ * Restacks the poker game's stack.
+ * 
+ * @param pokerGame Poker game to restack
+ */
+void pokerGameQueueRestack(pokergame_t *pokerGame);

src/game/poker/pokergameassets.h

@@ -11,5 +11,17 @@
 #include "../../locale/language.h"
 #include "../../display/texture.h"
 
+/**
+ * Load and initializes all the assets used by the poker game.
+ * 
+ * @param assets Assets instance to initailize.
+ * @return True if successful, otherwise false.
+ */
 bool pokerGameAssetsInit(pokergameassets_t *assets);
+
+/**
+ * Cleans a previously initialized game assets set.
+ * 
+ * @param assets Assets to dispose.
+ */
 void pokerGameAssetsDispose(pokergameassets_t *assets);

src/game/poker/pokerui.h

@@ -9,8 +9,23 @@
 #include <dawn/dawn.h>
 #include "../../ui/label.h"
 
+/**
+ * Initializes the UI Module.
+ * 
+ * @param pokerGame Poker game to initialize the UI for.
+ */
 void pokerUiInit(pokergame_t *pokerGame);
 
+/**
+ * Render the Poker Game UI.
+ * 
+ * @param pokerGame Game to render the UI for.
+ */
 void pokerUiRender(pokergame_t *pokerGame);
 
+/**
+ * Cleanup only the UI elements for a poker game.
+ * 
+ * @param pokerGame Game to dispose the UI for.
+ */
 void pokerUiDispose(pokergame_t *pokerGame);

src/physics/aabb.c

@@ -52,49 +52,5 @@ bool aabbPoint2D(
     hit->hitY = x + (halfHeight * sy);
   }
 
-  return true;
-}
-
-bool aabbVector2D(
-  float x, float y,
-  float vx, float vy,
-  float bx, float by, float width, float height,
-  aabbvectorhit2d_t *hit
-) {
-  // float halfWidth = width / 2.0;
-  // float halfHeight = height / 2.0;
-  // float paddingX = 0;
-  // float paddingY = 0;
-
-  // float scaleX = 1.0 / vx;
-  // float scaleY = 1.0 / vy;
-  // float signX = mathSign(scaleX);
-  // float signY = mathSign(scaleY);
-
-  // float nearTimeX = (bx - signX * (halfWidth + paddingX) - bx) * scaleX;
-  // float nearTimeY = (by - signY * (halfHeight + paddingY) - by) * scaleY;
-  // float farTimeX = (bx + signX * (halfWidth + paddingX) - bx) * scaleX;
-  // float farTimeY = (by + signY * (halfHeight + paddingY) - by) * scaleY;
-
-  // if(nearTimeX > farTimeY || nearTimeY > farTimeX) return false;
-
-  // float nearTime = nearTimeX > nearTimeY ? nearTimeX : nearTimeY;
-  // float farTime = farTimeX < farTimeY ? farTimeX : farTimeY;
-  // if (nearTime >= 1 || farTime <= 0) return false;
-
-  // hit->time = mathClamp(nearTime, 0, 1);
-  // if(nearTimeX > nearTimeY) {
-  //   hit->normalX = -signX;
-  //   hit->normalY = 0;
-  // } else {
-  //   hit->normalX = 0;
-  //   hit->normalY = -signY;
-  // }
-
-  // float deltaX = (1.0 - hit->time) * -vx;
-  // float deltaY = (1.0 - hit->time) * -vy;
-  // hit->hitX = bx + deltaX * hit->time;
-  // hit->hitY = by + deltaY * hit->time;
-
   return true;
 }

src/physics/aabb.h

@@ -10,14 +10,20 @@
 #include "sphere.h"
 #include "../input/input.h"
 
+/**
+ * Perform a test against a point and an AABB.
+ * 
+ * @param pointX Point X coordinate.
+ * @param pointY Point Y coordinate.
+ * @param x Box X coordinate.
+ * @param y Box Y coordinate.
+ * @param width Box width.
+ * @param height Box height.
+ * @param hit Pointer to hit information to store result in, or NULL for none.
+ * @return True if a hit occured, otherwise false.
+ */
 bool aabbPoint2D(
   float pointX, float pointY,
   float x, float y, float width, float height,
   aabbpointhit2d_t *hit
-);
-
-bool aabbVector2D(
-  float x, float y, float vx, float vy,
-  float bx, float by, float width, float height,
-  aabbvectorhit2d_t *vector
 );

src/util/array.h

@@ -113,5 +113,5 @@ int32_t arrayFindString(char **array, int32_t arrayLength, char *value);
  * @param count Count of items after start to use. Use -1 to take the remaining.
  */
 void arrayRewind(size_t size, void *source, int32_t length, int32_t start,
-  int32_t end
+  int32_t count
 );