From 108103ea2c8d39350a7d7ae9cd44469c1326182c Mon Sep 17 00:00:00 2001
From: Crayon2000 <crayon1@rocketmail.com>
Date: Mon, 9 Feb 2009 23:27:39 +0000
Subject: [PATCH] [CHG] Documentation improvement

---
 template/source/GRRLIB/GRRLIB.c |  6 ++++--
 template/source/GRRLIB/GRRLIB.h | 10 +++++-----
 template/source/main.c          |  1 +
 3 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/template/source/GRRLIB/GRRLIB.c b/template/source/GRRLIB/GRRLIB.c
index cda2954..7d64ef9 100644
--- a/template/source/GRRLIB/GRRLIB.c
+++ b/template/source/GRRLIB/GRRLIB.c
@@ -406,6 +406,7 @@ inline void GRRLIB_DrawTile(f32 xpos, f32 ypos, GRRLIB_texImg tex, float degrees
  * @param tex
  * @param color
  * @param zoom
+ * @param text
  * @param ... Optional arguments.
  */
 void GRRLIB_Printf(f32 xpos, f32 ypos, GRRLIB_texImg tex, u32 color, f32 zoom, const char *text, ...) {
@@ -511,7 +512,7 @@ void GRRLIB_FlushTex(GRRLIB_texImg tex)
  * Change a texture to gray scale.
  * @see GRRLIB_FlushTex
  * @param texsrc the texture source.
- * @param texdst the texture grayscaled destination.
+ * @param texdest the texture grayscaled destination.
  */
 void GRRLIB_BMFX_GrayScale(GRRLIB_texImg texsrc, GRRLIB_texImg texdest) {
     unsigned int x, y;
@@ -534,7 +535,7 @@ void GRRLIB_BMFX_GrayScale(GRRLIB_texImg texsrc, GRRLIB_texImg texdest) {
  * A texture effect.
  * @see GRRLIB_FlushTex
  * @param texsrc the texture source.
- * @param texdst the texture grayscaled destination.
+ * @param texdest the texture grayscaled destination.
  * @param factor The factor level of the effect. 
  */
 void GRRLIB_BMFX_Scatter(GRRLIB_texImg texsrc, GRRLIB_texImg texdest, int factor) {
@@ -563,6 +564,7 @@ void GRRLIB_BMFX_Scatter(GRRLIB_texImg texsrc, GRRLIB_texImg texdest, int factor
  *
  * @param v
  * @param color
+ * @param n
  * @param fmt
  */
 void GRRLIB_GXEngine(Vector v[], u32 color, long n, u8 fmt) {
diff --git a/template/source/GRRLIB/GRRLIB.h b/template/source/GRRLIB/GRRLIB.h
index e9f3cfe..3356325 100644
--- a/template/source/GRRLIB/GRRLIB.h
+++ b/template/source/GRRLIB/GRRLIB.h
@@ -25,11 +25,11 @@
 typedef struct GRRLIB_texImg{
     unsigned int w;         /**< width of the texture. */
     unsigned int h;         /**< height of the texture. */
-    unsigned int tilew;     /**< tilew widht of a tile. */
-    unsigned int tileh;     /**< tileh height of a tile. */
-    unsigned int nbtilew;   /**< nbtilew number of tiles for the x axis. */
-    unsigned int nbtileh;   /**< nbtileh number of tiles for the y axis. */
-    unsigned int tilestart; /**<  */
+    unsigned int tilew;     /**< widht of a tile. */
+    unsigned int tileh;     /**< height of a tile. */
+    unsigned int nbtilew;   /**< number of tiles for the x axis. */
+    unsigned int nbtileh;   /**< number of tiles for the y axis. */
+    unsigned int tilestart; /**< offset for starting position. */
     void *data;             /**< pointer to the texture data. */
 } GRRLIB_texImg;
 
diff --git a/template/source/main.c b/template/source/main.c
index 1754945..57f6750 100644
--- a/template/source/main.c
+++ b/template/source/main.c
@@ -226,6 +226,7 @@ int main() {
 
 /**
  * This function calculates the number of frames we render each second.
+ * It must be called right after GRRLIB_Render.
  * @return The number of frames per second.
  */
 static u8 CalculateFrameRate() {