From de36871c582a4f228df71e15560c020f34d39d4a Mon Sep 17 00:00:00 2001 From: Reiner Herrmann Date: Sat, 29 Jan 2011 16:20:40 +0100 Subject: added more documentation --- src/table_stacks.c | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/table_stacks.c') 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); -- cgit v1.2.3