From 7434caf77cfaf59f30eab2b3e6c55782b5af3d4a Mon Sep 17 00:00:00 2001
From: Dominic Masters <dominic@domsplace.com>
Date: Sun, 29 Aug 2021 12:57:42 -0700
Subject: [PATCH] Added more comments.

---
 src/poker/turn.h |  7 +++++++
 src/ui/frame.h   | 30 ++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/src/poker/turn.h b/src/poker/turn.h
index e8f5f68d..7e52c1b6 100644
--- a/src/poker/turn.h
+++ b/src/poker/turn.h
@@ -8,4 +8,11 @@
 #pragma once
 #include <dawn/dawn.h>
 
+/**
+ * Returns the AI result for a turn done by a non human player.
+ * 
+ * @param poker Poker game instance to use.
+ * @param playerIndex Player index to get the turn for.
+ * @return Some information about the move the player is trying to perform.
+ */
 pokerturn_t pokerTurnGet(poker_t *poker, uint8_t playerIndex);
\ No newline at end of file
diff --git a/src/ui/frame.h b/src/ui/frame.h
index f70d6fb9..fce5b211 100644
--- a/src/ui/frame.h
+++ b/src/ui/frame.h
@@ -11,12 +11,42 @@
 #include "../display/primitives/quad.h"
 #include "../display/gui/font.h"
 
+/**
+ * Initialize a GUI Frame.
+ * 
+ * @param frame Frame to initialize.
+ */
 void frameInit(frame_t *frame);
 
+/**
+ * Set the size of the frame (including the size of the border).
+ * 
+ * @param frame Frame to set the size of.
+ * @param width Width of the frame.
+ * @param height Height of the frame
+ */
 void frameSetSize(frame_t *frame, float width, float height);
 
+/**
+ * Set the size of the frame's innards (size excluding the borders).
+ * 
+ * @param frame Frame to set the size of
+ * @param width Width of the inner frame.
+ * @param height Height of the inner frame.
+ */
 void frameSetInnerSize(frame_t *frame, float width, float height);
 
+/**
+ * Render a game frame.
+ * 
+ * @param frame Frame to render.
+ * @param shader Shader to use while rendering.
+ */
 void frameRender(frame_t *frame, shader_t *shader);
 
+/**
+ * Cleanup a previously initialized frame.
+ * 
+ * @param frame Frame to dispose.
+ */
 void frameDispose(frame_t *frame);
\ No newline at end of file