From 947669f063f3df9fc93a4afb2d7c9e6d3d13813a Mon Sep 17 00:00:00 2001
From: Reiner Herrmann <reiner@reiner-h.de>
Date: Sat, 29 Jan 2011 15:34:18 +0100
Subject: added documentation

---
 src/main_stack.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src/main_stack.c')

diff --git a/src/main_stack.c b/src/main_stack.c
index bae4a88..0e9639a 100644
--- a/src/main_stack.c
+++ b/src/main_stack.c
@@ -1,6 +1,10 @@
 #include "main_stack.h"
 #include <stdlib.h>
 
+/**
+ * Initialize main stack: Assign valid cards and shuffle if
+ * @param[inout] m Pointer to main stack
+ */
 void main_stack_init(main_stack_t *m)
 {
 	assert(m != NULL);
@@ -20,6 +24,11 @@ void main_stack_init(main_stack_t *m)
 	}
 }
 
+/**
+ * Draw card on top of main stack and mark it as removed
+ * @param[inout] m Pointer to main stack
+ * @return Card on top of stack
+ */
 card main_stack_remove_card(main_stack_t *m)
 {
 	assert(m != NULL);
@@ -35,6 +44,11 @@ card main_stack_remove_card(main_stack_t *m)
 	return 0; // stack empty
 }
 
+/**
+ * Returns number of cards remaining in main stack
+ * @param[in] m Pointer to main stack
+ * @return Number of cards in stack
+ */
 uint8_t main_stack_size(const main_stack_t *m)
 {
 	assert(m != NULL);
-- 
cgit v1.2.3