Improve doxygen comments

This commit is contained in:
hasufell 2014-05-17 16:32:45 +02:00
parent 31d2bc5842
commit b5b35992c6
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020
2 changed files with 23 additions and 0 deletions

View File

@ -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

View File

@ -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]