summaryrefslogtreecommitdiff
path: root/src/table_stacks.c
diff options
context:
space:
mode:
authorReiner Herrmann <reiner@reiner-h.de>2011-01-29 16:20:40 +0100
committerReiner Herrmann <reiner@reiner-h.de>2011-01-29 16:20:40 +0100
commitde36871c582a4f228df71e15560c020f34d39d4a (patch)
tree07b5ee2e202b1bec7547e3b3ac8c857d7fec6540 /src/table_stacks.c
parenta85546a9a58ce313302f1be91923a14c5723375c (diff)
added more documentation
Diffstat (limited to 'src/table_stacks.c')
-rw-r--r--src/table_stacks.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/table_stacks.c b/src/table_stacks.c
index c93d44a..6230a1f 100644
--- a/src/table_stacks.c
+++ b/src/table_stacks.c
@@ -5,6 +5,12 @@
#include "card.h"
#include "game.h"
+/**
+ * Search index of table stack in which specified card is in
+ * @param[in] stack_list Pointer to list of stacks to search
+ * @param[in] c Card to search
+ * @return Index of table stack with specified card; invalid index (NUM_TABLE_STACKS) if none found
+ */
const uint8_t get_stack_idx_for_card(const table_stacks_t* stack_list, const card c)
{
assert(stack_list != NULL);