fries/GRRLIB
1
0
Fork 0
mirror of https://github.com/GRRLIB/GRRLIB.git synced 2024-11-22 15:02:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

[CHG] Improve documentation a bit

Browse source
This commit is contained in:
Crayon2000 2010-02-22 22:28:20 +00:00
parent 607a2e1966
commit a932d3ad7c
4 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
GRRLIB/GRRLIB/GRRLIB_core.c
View file

@ -40,7 +40,7 @@ static void *gp_fifo = NULL;
static bool is_setup = false; // To control entry and exit static bool is_setup = false; // To control entry and exit
/** /**
* Initialize GRRLIB. Call this at the beginning your code. * Initialize GRRLIB. Call this once at the beginning your code.
* @return int 0=OK; -1=NoMemory; -2=NoFilingSystem * @return int 0=OK; -1=NoMemory; -2=NoFilingSystem
* @see GRRLIB_Exit * @see GRRLIB_Exit
*/ */

8
GRRLIB/GRRLIB/grrlib.h
View file

@ -101,16 +101,16 @@ typedef struct GRRLIB_drawSettings {
* Structure to hold the texture information. * Structure to hold the texture information.
*/ */
typedef struct GRRLIB_texImg { typedef struct GRRLIB_texImg {
uint w; /**< Texture width. */ uint w; /**< The width of the texture in pixels. */
uint h; /**< Texture height. */ uint h; /**< The height of the texture in pixels. */
int handlex; /**< Texture handle x. */ int handlex; /**< Texture handle x. */
int handley; /**< Texture handle y. */ int handley; /**< Texture handle y. */
int offsetx; /**< Texture offset x. */ int offsetx; /**< Texture offset x. */
int offsety; /**< Texture offset y. */ int offsety; /**< Texture offset y. */
bool tiledtex; /**< Texture is tiled if set to true. */ bool tiledtex; /**< Texture is tiled if set to true. */
uint tilew; /**< Width of one tile. */ uint tilew; /**< The width of one tile in pixels. */
uint tileh; /**< Height of one tile. */ uint tileh; /**< The height of one tile in pixels. */
uint nbtilew; /**< Number of tiles for the x axis. */ uint nbtilew; /**< Number of tiles for the x axis. */
uint nbtileh; /**< Number of tiles for the y axis. */ uint nbtileh; /**< Number of tiles for the y axis. */
uint tilestart; /**< Offset to tile starting position. */ uint tilestart; /**< Offset to tile starting position. */

6
GRRLIB/GRRLIB/grrlib/GRRLIB_handle.h
View file

@ -26,7 +26,8 @@ THE SOFTWARE.
*/ */
/** /**
* Set a texture's X and Y handles. e.g. for rotation. * Set a texture's X and Y handles.
* For example, it could be used for the rotation of a texture.
* @param tex The texture to set the handle on. * @param tex The texture to set the handle on.
* @param x The x-coordinate of the handle. * @param x The x-coordinate of the handle.
* @param y The y-coordinate of the handle. * @param y The y-coordinate of the handle.
@ -43,7 +44,8 @@ void GRRLIB_SetHandle (GRRLIB_texImg *tex, const int x, const int y) {
} }
/** /**
* Center a texture's handles. e.g. for rotation. * Center a texture's handles.
* For example, it could be used for the rotation of a texture.
* @param tex The texture to center. * @param tex The texture to center.
* @param enabled * @param enabled
*/ */

2
grrlib.doxygen
View file

@ -1,4 +1,4 @@
# Doxyfile 1.6.2 # Doxyfile 1.6.3
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project # doxygen (www.doxygen.org) for a project