From b5b35992c63cfa83f7865292b793c1f5565225e9 Mon Sep 17 00:00:00 2001
From: hasufell <hasufell@hasufell.de>
Date: Sat, 17 May 2014 16:32:45 +0200
Subject: [PATCH] Improve doxygen comments

---
 src/gl_draw.c      | 20 ++++++++++++++++++++
 src/half_edge_AS.c |  3 +++
 2 files changed, 23 insertions(+)

diff --git a/src/gl_draw.c b/src/gl_draw.c
index 9c34c18..316bd4a 100644
--- a/src/gl_draw.c
+++ b/src/gl_draw.c
@@ -498,25 +498,45 @@ void animate()
  * Keyboard callback function,
  *
  * press t to increase the day
+ *
  * press T to decrease the day
+ *
  * press j to increase the year
+ *
  * press J to decrease the year
+ *
  * press b to toggle GL_CULL_FACE
+ *
  * press D to toggle disco mode
+ *
  * press S to toggle shade model between GL_SMOOTH and GL_FLAT
+ *
  * press n to toggle normals
+ *
  * press k to increase length of normals
+ *
  * press l to decrease length of normals
+ *
  * press x to rotate the middle object in x direction
+ *
  * press X to rotate the middle object in -x direction
+ *
  * press y to rotate the middle object in y direction
+ *
  * press Y to rotate the middle object in -y direction
+ *
  * press c to rotate the middle object in z direction
+ *
  * press C to rotate the middle object in -z direction
+ *
  * press w to translate the whole scene in y direction
+ *
  * press s to translate the whole scene in -y direction
+ *
  * press a to translate the whole scene in -x direction
+ *
  * press d to translate the whole scene in x direction
+ *
  * press q to quit
  *
  * @param key which was pressed
diff --git a/src/half_edge_AS.c b/src/half_edge_AS.c
index 0f821b2..76e701e 100644
--- a/src/half_edge_AS.c
+++ b/src/half_edge_AS.c
@@ -60,6 +60,9 @@ static void delete_raw_object(obj_items *raw_obj,
  * strtok_r calls which allow us to parse the whole string only
  * once.
  *
+ * NOTE: This function can be buggy for trailing whitespaces on
+ * the end of lines or dos line endings.
+ *
  * @param obj_string the string that is in obj format
  * @param raw_obj contains arrays of the items as they are in the .obj
  * file; members v, f and vt are set [out]