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/card.c | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/card.c')

diff --git a/src/card.c b/src/card.c
index 25db247..5132be6 100644
--- a/src/card.c
+++ b/src/card.c
@@ -1,6 +1,14 @@
 #include "card.h"
 #include <assert.h>
 
+/**
+ * Calculate the score of a single card
+ * Cards divisible by  5:            2 points
+ * Cards divisible by 10:            3 points
+ * Cards divisible by 11:            5 points
+ * Card 55 (divisible by 5 and 11):  7 points
+ * @return Score of the card
+ */
 uint32_t card_get_points(const card c)
 {
 	assert(c > 0 && c <= 105);
-- 
cgit v1.2.3